Skip to content

Commit 21a34ed

Browse files
committed
Move note to remarks
1 parent dd3cbfb commit 21a34ed

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

xml/Microsoft.Extensions.Logging/ILogger.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@
141141
<param name="eventId">Id of the event.</param>
142142
<param name="state">The entry to be written. Can also be an object.</param>
143143
<param name="exception">The exception related to this entry.</param>
144-
<param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />. **Note: When using extension methods such as <see cref="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])"/> and <see cref="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])"/>, the function passed here will not add the <paramref name="exception"/> parameter to the log message. When using these overloads, implementations should explicitly append the <paramref name="exception"/> to the log message.**</param>
144+
<param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
145145
<summary>Writes a log entry.</summary>
146-
<remarks>To be added.</remarks>
146+
<remarks>Note: When using extension methods such as <see cref="M:Microsoft.Extensions.Logging.LoggerExtensions.Log(Microsoft.Extensions.Logging.ILogger,Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,System.Exception,System.String,System.Object[])"/> and <see cref="M:Microsoft.Extensions.Logging.LoggerExtensions.LogError(Microsoft.Extensions.Logging.ILogger,System.Exception,System.String,System.Object[])"/>, the <paramref name "formatter"> provided to this method will not add the <paramref name="exception"/> to the log message. When using these extension methods, implementations should explicitly append the <paramref name="exception"/> to the log message.</remarks>
147147
</Docs>
148148
</Member>
149149
</Members>

0 commit comments

Comments
 (0)