dotnet / dotnet/dotnet-api-docs

Documentation updation ILogger interface

Open
#9,205 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

### Is your feature request related to a problem? Please describe.

When using an instance of logging from ASP .Net in `net6.0` of like say `ILogger logger` and if I do `logger.logDebug( ... )`, the method does not have a clear and concise description as to like when it is displayed ( like when enabling LogLevel in appsettings....json ) and also no mention of the color it is displayed in the log console. One has to visit [here](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line) to understand it every time they do not recall about the usage.

Right now the documentation summary reads like ` Formats and writes an error log message.` which is more or less self explanatory and not much utile in numerous ways.

Area -
``
`namespace Microsoft.Extensions.Logging`

PS - Issue already asked [here](https://github.com/dotnet/sdk/issues/34800)

### Describe the solution you'd like
A clear and concise description of what each of the `..logDebug(...)`, `..logError(...)` and other methods does. On what conditions are they printed in the logs like `LogLevel` information and of course the color in which they will be printed like `background` and `font` or both.

### Additional context
The more the information helping the developer when referencing the summary information for the method(s), the better and in a way one does not have to avoid spending more time on looking for such information it online and similar.

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.