Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upFix rustdoc comment syntax #32
Merged
Conversation
I also moved the comment block to the top of the file so that rustdoc won't throw "expected outer comment" error
|
Thanks! |
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.
Suggestions cannot be applied on multi-line comments.
mohtar commentedApr 27, 2015
The correct syntax for module level documentation is
//!, not///!. This will make the doc text appear on the crate documentation's first page.I also moved the comment block to the top of the file so that rustdoc won't throw "expected outer comment" error.