Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
Add doc comments to public APIs
See original GitHub issueThis repo currently has a lot of public APIs without any doc comments.
There’s already an issue (#610) about adding doc comments for EventId.
There’s also a pretty old PR (#529) to add doc comments to console logger types. Having doc comments to indicate things like the default value of ConsoleLoggerOptions.IncludeScopes could certainly be useful. There are other console logging types that don’t have doc comments like IConsoleLoggerSettings, but I haven’t created an exhaustive list.
None of the (extension) methods on ILoggingBuilder (i.e. AddFilter, AddProvider, ClearProviders, SetMinimuLevel) have doc comments.
I Think it would be particularly useful to note in the SetMinimumLevel doc comments that the default LogLevel is Information meaning that Trace and Debug logs will be ignored. I think this should be noted on any API where a minimum level can be set.
Issue Analytics
- State:
- Created 6 years ago
- Reactions:1
- Comments:6 (1 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
I just learned that SetMinimumLoggingLevel gets overridden by what’s configured in appsettings.json when using WebHost.CreateDefaultBuilder. I don’t think this is obvious. While this is probably too detailed to go into a doc comment, I think this should be documented somewhere.
These will be handled by the docs process in dotnet/runtime now, since the packages have moved there and the XML docs are handled in dotnet/dotnet-api-docs