A few improvements to the documentation #16
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes a bunch of changes to the documentation in order to fix:
slog
).RUST_LOG
.init()
/try_init()
docs.unwrap()
inBuilder
doc string.Logger::new()
andLogger:filter()
. Expand doc string forLogger
to give more context and links to the typical ways of constructing it.Please let me know if you'd like these changes as separate PRs - they are already separated by commit.
This PR needs the changes from #15 before it will compile or pass tests. (I've merged the two branches locally and confirmed both
cargo check
/cargo doc
andcargo test
produce the correct output).