Skip to content

Update ILogger documentation to clarify formatter behavior when using extension methods #10345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2024
Merged

Update ILogger documentation to clarify formatter behavior when using extension methods #10345

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dd3cbfb
Update `ILogger` documentation to clarify formatter behavior when usi…
enioluwas Aug 30, 2024
21a34ed
Move note to remarks
enioluwas Aug 30, 2024
f490ee1
Update based on feedback
enioluwas Aug 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Logging/ILogger.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
<param name="eventId">Id of the event.</param>
<param name="state">The entry to be written. Can also be an object.</param>
<param name="exception">The exception related to this entry.</param>
<param name="formatter">Function to create a <see cref="T:System.String" /> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
<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>
<summary>Writes a log entry.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down