search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
737 stars 1.57k forks source link

LogError API documentation is missing critical information #10439

Open Maintenance-Partnership-Systems opened 1 month ago

Maintenance-Partnership-Systems commented 1 month ago

Type of issue

Missing information

Description

The documentation for the LogError API call (and probably also LogWarning, etc) do not explain how the textual placekeepers in the error message are mapped to the object array passed in to the method. They presumable are - somehow - and the mechanism is probably explained - somewhere - just not at the point you reach when you press "F1" on the method name in Visual Studio; i.e. the first point of contact with the documentation. It needs either an explanation, or a link to the explanation.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loggerextensions.logerror?view=net-8.0#microsoft-extensions-logging-loggerextensions-logerror(microsoft-extensions-logging-ilogger-system-string-system-object())

Content source URL

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

Document Version Independent Id

2cd26c9d-5a49-c860-6585-98ba4a7b2f1d

Article author

@dotnet-bot

dotnet-policy-service[bot] commented 1 month ago

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