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.

Sign up for GitHub

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

Jump to bottom

lint mode for missing docs #6275

Closed
metajack opened this issue May 6, 2013 · 3 comments
Closed

lint mode for missing docs #6275

metajack opened this issue May 6, 2013 · 3 comments
Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@metajack
Copy link
Contributor

metajack commented May 6, 2013

I would like to see a lint mode that could warn on missing documentations, hopefully by type. Something like -Wdoc-trait or -Wdoc-struct to warn on missing docs on traits or structs, etc.
@graydon
Copy link
Contributor

graydon commented May 6, 2013

nominating for well-covered.

@graydon
Copy link
Contributor

graydon commented May 9, 2013

accepted for well-covered milestone

@Xazax-hun Xazax-hun mentioned this issue May 24, 2013
Merged
@alexcrichton
Copy link
Member

After #6715 and #6798, I think this can be closed. If there are missing things that need lints for documentation, I think they should have individual bugs.

@sanxiyn sanxiyn mentioned this issue Jun 24, 2013
Closed
osaut pushed a commit to osaut/rust that referenced this issue Oct 31, 2013
@bors
auto merge of rust-lang#6715 : Xazax-hun/rust/incoming, r=graydon
5d04ee8 
Preliminary implementation for: rust-lang#6275

This is my first (non hello world) rust code, so it may not be idiomatic.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@graydon @metajack @alexcrichton