hobofan / ronat Goto Github PK

Via docstrings

Example:

/// This is an header.
///
/// # Parameters
///
/// - `foo`: Incorrect variable name
#[deny(doc_params_mismatch)]
pub fn somefunction(bar: isize) {
}

Should give a warning that there is no parameter named foo.

Some lints on simple grammar and language style would be nice.

Via docstrings

Example:

/// This is an header.
///
/// # Parameters
///
/// - `second`: Another parameter
/// - `first`: Some parameter
#[deny(doc_params_unordered)]
pub fn somefunction(first: isize, second: usize) {
}

Should give a warning that baz is documented before bar. Not sure if that provides much value, but why not? 😄

Having a cargo command that acts similar to the way clippy does, would be awesome to have.

Currently, the markdown parser that is used destroys the line/character information, making it hard to impossible to restore the correct association to the misspelled word in the original comment.

One easy workaround would be to search for the misspelled word in the original comment, which could lead to finding the wrong instance of the word. This might not be a problem, since every instance of the misspelled word should be marked.

Another solution would be to replace the markdown parser with a pull-parser, which should make it easier to keep the association to the original comment location.

As mentioned in rust-lang/style-team#17 (comment):

Comments should be complete sentences. Start with a capital letter, (usually) end with a period (.)

Via docstrings

Example:

/// This is an header.
///
/// # Parameters
///
/// - `bar`: Some parameter
#[deny(doc_params_incomplete)]
pub fn somefunction(bar: isize, baz: usize) {
}

Should give a warning that there is no documentation for baz. Should only error if at least one of the parameters is documented.

I just found out that rustfmt has some style checks (though not lints):
https://github.com/rust-lang-nursery/rustfmt/blob/49e86a1e6501b261e6fef530d478ad0ea5ff3814/src/comment.rs

I haven't really looked into it in-depth, but there might be a few things in there that could be interesting.

There is also a fmt-RFC that could provide some inspiration for lints: rust-lang/style-team#17