Skip to content

Commit

Permalink
Update IHttpClientLogger.cs and IHttpClientAsyncLogger.cs remarks (#1…
Browse files Browse the repository at this point in the history
…09618)

* Update IHttpClientLogger.cs remarks

Updated IHttpClientLogger remarks to provide clearer documentation to a developer implementing this interface

* Update IHttpClientAsyncLogger.cs

Updated remarks to provide the developer implementing this interface clearer documentation

---------

Co-authored-by: Natalia Kondratyeva <[email protected]>
  • Loading branch information
danespinosa and CarnaViire authored Nov 11, 2024
1 parent 35d2780 commit 7ee5b7d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace Microsoft.Extensions.Http.Logging
/// would be called from the corresponding sync code paths.
/// </para>
/// <para>
/// It is up to the user implementing the interface to decide where (to <see cref="Microsoft.Extensions.Logging.ILogger"/>, or anything else) and what exactly to log.
/// It is up to the user implementing the interface to decide whether to use <see cref="Microsoft.Extensions.Logging.ILogger"/>, or anything else, and what exactly to log.
/// However, the implementation should be mindful about potential adverse side effects of accessing some of the <see cref="HttpRequestMessage"/> or
/// <see cref="HttpResponseMessage"/> properties, such as reading from a content stream; if possible, such behavior should be avoided.
/// </para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace Microsoft.Extensions.Http.Logging
/// </summary>
/// <remarks>
/// <para>
/// It is up to the user implementing the interface to decide where (to <see cref="Microsoft.Extensions.Logging.ILogger"/>, or anything else) and what exactly to log.
/// It is up to the user implementing the interface to decide whether to use <see cref="Microsoft.Extensions.Logging.ILogger"/>, or anything else, and what exactly to log.
/// However, the implementation should be mindful about potential adverse side effects of accessing some of the <see cref="HttpRequestMessage"/> or
/// <see cref="HttpResponseMessage"/> properties, such as reading from a content stream; if possible, such behavior should be avoided.
/// </para>
Expand Down

0 comments on commit 7ee5b7d

Please sign in to comment.