Grammatical inconsistencies in the documentation #11830
Comments
|
Indeed, this is a duplicate of #4361, sorry. |
|
Thanks for searching. I've transfered my comments to that issue. |
|
If this is a duplicate, should it be closed? |
|
Yes, it should be closed as a duplicate. |
bors
added a commit
to rust-lang-ci/rust
that referenced
this issue
Jul 25, 2022
On typing handler for angle brackets(<) with snippets I implemented my idea in rust-lang#11398 in "cargo cult programming"-style without actually know what I'm doing, so feedback is welcome. The PR is split into two commits to ease the review. I used `@unexge's` original prototype, which forms the basis of the PR.
flip1995
pushed a commit
to flip1995/rust
that referenced
this issue
Feb 8, 2024
…p1995 Add `lint_groups_priority` lint Warns when a lint group in Cargo.toml's `[lints]` section shares the same priority as a lint. This is in the cargo section but is categorised as `correctness` so it's on by default, it doesn't call `cargo metadata` though and parses the `Cargo.toml` directly The lint should be temporary until rust-lang/cargo#12918 is resolved, but in the meanwhile this is an common issue to run into - rust-lang#11237 - rust-lang#11751 - rust-lang#11830 changelog: Add [`lint_groups_priority`] lint r? `@flip1995`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The example of the
std::nummodule speaks for itself. I can count at least three grammatical forms among the function descriptions:abs: Computes the absolute value.);acos: Compute the arccosine of the number.);abs_sub: The positive difference of two numbers.orcos: 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.
The text was updated successfully, but these errors were encountered: