dotnet / dotnet/dotnet-api-docs

LogError API documentation is missing critical information

Open
#10,439 1 comment 0 reactions 0 assignees View on GitHub
area-Extensions-Logging Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

### 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.