Skip to content

missing_doc lint expects docs on private traits #11592

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
sfackler opened this issue Jan 16, 2014 · 1 comment · Fixed by #23852
Closed

missing_doc lint expects docs on private traits #11592

sfackler opened this issue Jan 16, 2014 · 1 comment · Fixed by #23852
Assignees
@emberian
Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut.

Comments

@sfackler
Copy link
Member

missing_doc uses the exported items set from the visibility pass to determine if items are public, but 0daaeab changed that pass to treat all traits as exported.
@sfackler
Copy link
Member Author

cc @alexcrichton

sfackler added a commit to sfackler/rust that referenced this issue May 25, 2014
@sfackler
Fix missing_doc lint
d4f340a 
Some items including traits are exported even when they aren't public,
so the missing_doc lint used to warn for private traits.

Closes rust-lang#11592
@sfackler sfackler mentioned this issue May 25, 2014
Closed
@tomjakubowski tomjakubowski mentioned this issue Oct 30, 2014
Closed
@tomjakubowski tomjakubowski mentioned this issue Dec 23, 2014
Closed
@steveklabnik steveklabnik added the A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. label Jan 23, 2015
@emberian emberian self-assigned this Mar 26, 2015
@emberian emberian mentioned this issue Mar 30, 2015
Merged
Manishearth added a commit to Manishearth/rust that referenced this issue Mar 31, 2015
@Manishearth
Rollup merge of rust-lang#23852 - cmr:missing_doc, r=Manishearth
2c0329c 
Due to a long-standing conservative approach to trait exports, all traits are
considered exported. However, the missing_docs lint uses the export map to
determine if something is public and ought to have documentation. This commit
modifies the lint to check if traits are private before emitting the warning.

Closes rust-lang#11592
flip1995 pushed a commit to flip1995/rust that referenced this issue Oct 6, 2023
@bors
Auto merge of rust-lang#11592 - schubart:fix_documentation_link, r=fl…
ec15630 
…ip1995

Fix documentation link

The file pointed to by the old link

    https://github.com/rust-lang/rust-clippy/blob/557f6848bd5b7183f55c1e1522a326e9e1df6030/clippy_lints/src/lib.rs#L110

did not talk about categories and levels.

The new link (hopefully) points here

    https://doc.rust-lang.org/stable/clippy/

which has a nice table explaining the mappings.

changelog: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emberian emberian

Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

lint: handle private traits better
Fix missing_doc lint sfackler/rust
3 participants
@steveklabnik @emberian @sfackler