From dd3cbfbeb7a7d6c09c9586395e8fb4803f035ff4 Mon Sep 17 00:00:00 2001 From: Enioluwa Segun Date: Fri, 30 Aug 2024 16:43:59 -0400 Subject: [PATCH 1/3] Update `ILogger` documentation to clarify formatter behavior when using extension methods --- xml/Microsoft.Extensions.Logging/ILogger.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/Microsoft.Extensions.Logging/ILogger.xml b/xml/Microsoft.Extensions.Logging/ILogger.xml index b2c5b9ad8ff..f5aacf197f7 100644 --- a/xml/Microsoft.Extensions.Logging/ILogger.xml +++ b/xml/Microsoft.Extensions.Logging/ILogger.xml @@ -141,7 +141,7 @@ Id of the event. The entry to be written. Can also be an object. The exception related to this entry. - Function to create a message of the and . + Function to create a message of the and . **Note: When using extension methods such as and , the function passed here will not add the parameter to the log message. When using these overloads, implementations should explicitly append the to the log message.** Writes a log entry. To be added. From 21a34ed60f873a984a6d3a1873db64f9b50c1556 Mon Sep 17 00:00:00 2001 From: Enioluwa Segun Date: Fri, 30 Aug 2024 17:57:32 -0400 Subject: [PATCH 2/3] Move note to remarks --- xml/Microsoft.Extensions.Logging/ILogger.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/Microsoft.Extensions.Logging/ILogger.xml b/xml/Microsoft.Extensions.Logging/ILogger.xml index f5aacf197f7..293aedea9de 100644 --- a/xml/Microsoft.Extensions.Logging/ILogger.xml +++ b/xml/Microsoft.Extensions.Logging/ILogger.xml @@ -141,9 +141,9 @@ Id of the event. The entry to be written. Can also be an object. The exception related to this entry. - Function to create a message of the and . **Note: When using extension methods such as and , the function passed here will not add the parameter to the log message. When using these overloads, implementations should explicitly append the to the log message.** + Function to create a message of the and . Writes a log entry. - To be added. + Note: When using extension methods such as and , the provided to this method will not add the to the log message. When using these extension methods, implementations should explicitly append the to the log message. From f490ee1754d4955753244c62e6229c2b264165de Mon Sep 17 00:00:00 2001 From: Enioluwa Segun Date: Fri, 30 Aug 2024 20:15:28 -0400 Subject: [PATCH 3/3] Update based on feedback --- xml/Microsoft.Extensions.Logging/ILogger.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/Microsoft.Extensions.Logging/ILogger.xml b/xml/Microsoft.Extensions.Logging/ILogger.xml index 293aedea9de..3d70865898f 100644 --- a/xml/Microsoft.Extensions.Logging/ILogger.xml +++ b/xml/Microsoft.Extensions.Logging/ILogger.xml @@ -1,4 +1,4 @@ - + @@ -143,7 +143,7 @@ The exception related to this entry. Function to create a message of the and . Writes a log entry. - Note: When using extension methods such as and , the provided to this method will not add the to the log message. When using these extension methods, implementations should explicitly append the to the log message. + The default provided by the logger extension methods doesn't include the when formatting messages. It's essential for implementations of this method to decide how exceptions should be incorporated into the logs.