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

conversion of doc comments to indicative mood #4174

Merged
merged 1 commit into from
Oct 19, 2021

Conversation

antogilbert
Copy link
Contributor

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.

@Darksonn Darksonn added A-tokio Area: The main tokio crate T-docs Topic: documentation labels Oct 18, 2021
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't been through everything yet, but a few comments:

tokio/src/io/driver/scheduled_io.rs Outdated Show resolved Hide resolved
tokio/src/loom/std/mutex.rs Outdated Show resolved Hide resolved
tokio/src/runtime/basic_scheduler.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to go through the entirety of Tokio!

tokio/src/time/driver/wheel/mod.rs Outdated Show resolved Hide resolved
Conversion of doc comments from imperative to
indicative mood. Addition of trailing periods
as well.

Fixes: tokio-rs#4074
@Darksonn Darksonn merged commit 03969cd into tokio-rs:master 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
Labels
A-tokio Area: The main tokio crate T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc comments are often written in the imperative mood
2 participants