Remarks section is a partially written sentence

[mtaylorfsmb]

Type of issue

Missing information

Description

The remarks section for IHttpClientEnricher.Enrich is a partial sentence that seems to have been generated from 2 different sentences. It is unclear and needs to be rewritten and made into a proper sentence.

Please be aware that depending on the result of the HTTP request the response and exception parameters may be null.

It seems like it is trying to say that depending on the result of the HTTP request that the response and exception parameters may be null. But either it is missing punctuation or it is trying to say something else. When I read it originally I read it as "the request the response and exception parameters may be null". However I don't believe the request can be null if it gets this far into the pipeline.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.http.logging.ihttpclientlogenricher.enrich?view=net-9.0-pp

Content source URL

https://github.com/dotnet/dotnet-api-docs/blob/main/xml/Microsoft.Extensions.Http.Logging/IHttpClientLogEnricher.xml

Document Version Independent Id

e01bbeb9-656b-c324-7483-9f6a9a8e6ae2

Platform Id

a7ae245b-a0ab-8628-1c33-d8f67f7ae4d8

Article author

@dotnet-bot

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/area-extensions-logging

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/ncl

[tarekgh]

CC @evgenyfedorov2 @geeknoid

[antonfirsov]

@gewarren do we have area label(s) for stuff owned by dotnet/extensions folks?

[gewarren]

@antonfirsov I didn't create the area labels, I think @jeffhandley did. We do have area labels for at least some of the APIs from dotnet/extensions, for example, the AI areas.

[evgenyfedorov2]

Fixed in dotnet/extensions#6485