Skip to content

missing_docs lint ignores pub consts #24249

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
Closed
crumblingstatue opened this issue Apr 9, 2015 · 0 comments
Closed

missing_docs lint ignores pub consts #24249

crumblingstatue opened this issue Apr 9, 2015 · 0 comments
Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut.

Comments

@crumblingstatue
Copy link
Contributor 

//! A lonely crate
#![warn(missing_docs)]
pub const FOO: i32 = 0;

This should warn about missing documentation for FOO, but it doesn't.
@steveklabnik steveklabnik added the A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. label Apr 10, 2015
@ghost ghost mentioned this issue Jun 21, 2015
Merged
bors added a commit that referenced this issue Jul 5, 2015
@bors
Auto merge of #26473 - Eljay:missing_docs, r=alexcrichton
5d3b0f1 
Fixes #24249

I've tagged all items that were missing docs to allow them to compile for now, the ones in core/num should probably be documented at least.

This is also a breaking change for any crates using `#[deny(missing_docs)]` that have undocumented constants, not sure there is any way to avoid this without making it a separate lint?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@steveklabnik @crumblingstatue