conversion of doc comments to indicative mood #4174
Merged
Conversation
This file contains 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
Darksonn
reviewed
Oct 18, 2021
antogilbert
force-pushed
the
comments_fix
branch
from
c8c99f9
to
057dd82
Compare
Darksonn
reviewed
Oct 18, 2021
Conversion of doc comments from imperative to indicative mood. Addition of trailing periods as well. Fixes: tokio-rs#4074
antogilbert
force-pushed
the
comments_fix
branch
from
057dd82
to
8650eda
Compare
Darksonn
approved these changes
Oct 19, 2021
oliver-giersch
pushed a commit
to oliver-giersch/tokio
that referenced
this pull request
Oct 28, 2021
Co-authored-by: Antonello Palazzi <antonello.palazzi@gmail.com>
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Conversion of doc comments from imperative to
indicative mood. Addition of trailing periods
as well.
Fixes: #4074
Motivation
As explained in Issue #4074:
tokio's doc comments are written in a mixture of the indicative mood and imperative mood. They should all be in the indicative mood (e.g. "Returns foo"), to match the stdlib and the standard rustdoc conventions.
Solution
Adapt the doc comments of the main crate to use indicative mood. In addition missing trailing periods were added.