Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A few improvements to the documentation #16

Merged
merged 5 commits into from
Aug 22, 2017
Merged

A few improvements to the documentation #16

merged 5 commits into from
Aug 22, 2017

Conversation

mjkillough
Copy link
Contributor

This PR makes a bunch of changes to the documentation in order to fix:

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 and cargo test produce the correct output).

Make reference to log crate into a hyperlink. Add an extra line to the
summary at the beginning of the module-level documentation to indicate
that this crate should be used with the standard logging facade (unlike
something like `slog`).

Fixes #11.
Most uses already used a monospace font, but a couple were left out.
Also provide some more context in the doc string for the `Logger`
struct.

Fixes #8.
@mjkillough mjkillough changed the title Docs A few improvements to the documentation Aug 21, 2017
@sebasmagri sebasmagri merged commit 5237ee4 into rust-cli:master Aug 22, 2017
@sebasmagri
Copy link
Collaborator

Thanks!

epage added a commit to epage/env_logger that referenced this pull request Apr 17, 2024
chore(deps): Update pre-commit/action action to v3.0.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants