This repository was archived by the owner on Oct 9, 2018. It is now read-only.
Update style documentation for doc comments #25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Third person singular present indicative form is, I believe, the dominant form used in modern Rust documentation.
The markdown that Rustdoc supports is very close to GitHub Flavored Markdown, which includes a number of extensions on top of the original Markdown language.
|
Thanks, this is great! |
aturon
added a commit
that referenced
this pull request
Jul 29, 2014
Update style documentation for doc comments
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Document the expected tense for doc comment summaries, and elaborate on
the supported Markdown syntax.