Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upAdd more documentation to Metadata struct #177
Conversation
dtolnay
reviewed
May 27, 2017
src/lib.rs
Outdated
| /// `Record`s use `Metadata` to determine the log message's severity | ||
| /// and target. | ||
| /// | ||
| /// |
This comment has been minimized.
This comment has been minimized.
dtolnay
May 27, 2017
Member
Please remove the extra blank line. Rustdoc treats this just like one blank line anyway.
src/lib.rs
Outdated
| /// Users should use the `log_enabled!` macro in their code to avoid | ||
| /// constructing expensive log messages. | ||
| /// | ||
| /// ## Examples |
This comment has been minimized.
This comment has been minimized.
src/lib.rs
Outdated
| /// ```rust | ||
| /// # #[macro_use] | ||
| /// # extern crate log; | ||
| /// |
This comment has been minimized.
This comment has been minimized.
dtolnay
May 27, 2017
Member
This will include a blank line at the top of the example code. Please put # on this line to hide it.
This comment has been minimized.
This comment has been minimized.
|
Thank you! |
dtolnay
merged commit 7cc258c
into
rust-lang-nursery:master
May 27, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
MarkMcCaskey commentedMay 27, 2017
The example is pretty redundant (copied almost verbatim from another example). Let me know what I should add or remove to make this better!
Thanks!