Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.

Have rustdoc output lints for better docs #77

Open
mgattozzi opened this issue Jul 27, 2017 · 5 comments
Open

Have rustdoc output lints for better docs #77

mgattozzi opened this issue Jul 27, 2017 · 5 comments

Comments

@mgattozzi
Copy link
Contributor

This is probably far off but it would be nice to lint doc output so that people can write better docs. For instance avoiding usage of words like "Simply" or "Just". This can help provide standardization of best practices and help guide the community towards higher quality documentation. Of course we should provide the options to turn off these items like any other linting tool.

I would also think that having it only on for building your own crate or binary would be good. Having lints from other projects show up during the build process is annoying.

@steveklabnik
Copy link
Owner

Marking as "Quest" because this is a big thing that someone will need to think through all the details of.

@mgattozzi
Copy link
Contributor Author

Yeah this is by no means an easy thing at all and I wouldn't expect this to be done till way after the basic functionality is implemented.

@steveklabnik
Copy link
Owner

Checking for stuff like https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md would be 👍 too

@mgattozzi
Copy link
Contributor Author

I think #78 is also tangentially related to this.

@steveklabnik
Copy link
Owner

Marking this as hard because there's a lot of work in determining what the lints should be, not just implementing them.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants