Skip to content

Commit 212eb2d

Browse files
authored
Merge pull request dotnet#10345 from enioluwas/main
Update `ILogger` documentation to clarify formatter behavior when using extension methods
2 parents 1667ba9 + f490ee1 commit 212eb2d

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
@@ -1,4 +1,4 @@
1-
<Type Name="ILogger" FullName="Microsoft.Extensions.Logging.ILogger">
1+
<Type Name="ILogger" FullName="Microsoft.Extensions.Logging.ILogger">
22
<TypeSignature Language="C#" Value="public interface ILogger" />
33
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ILogger" />
44
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Logging.ILogger" />
@@ -143,7 +143,7 @@
143143
<param name="exception">The exception related to this entry.</param>
144144
<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>The default <paramref name="formatter" /> provided by the logger extension methods doesn't include the <paramref name="exception" /> when formatting messages. It's essential for implementations of this method to decide how exceptions should be incorporated into the logs.</remarks>
147147
</Docs>
148148
</Member>
149149
</Members>

0 commit comments

Comments
 (0)