Skip to content

Grammatical inconsistencies in the documentation #11830

Closed
@Armavica

Description

@Armavica

The example of the std::num module speaks for itself. I can count at least three grammatical forms among the function descriptions:

  • indicative form (abs: Computes the absolute value.);
  • imperative form (acos: Compute the arccosine of the number.);
  • noun phrase (abs_sub: The positive difference of two numbers. or cos: Cosine function).

The various style guides (https://github.com/mozilla/rust/wiki/Note-style-guide, https://github.com/mozilla/rust/wiki/Doc-using-rustdoc and http://static.rust-lang.org/doc/master/rustdoc.html) recommend writing "sentences that begin with capital letters and end in a period" but do not mention how the sentences should be formed.

I am willing to work on making all this coherent but a convention should be fixed first.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions