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

rustdoc should label must_use types. #20109

Closed
aatxe opened this issue Dec 21, 2014 · 2 comments · Fixed by #22224
Closed

rustdoc should label must_use types. #20109

aatxe opened this issue Dec 21, 2014 · 2 comments · Fixed by #22224
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@aatxe
Copy link
Member

aatxe commented Dec 21, 2014

Currently, the only way to know that a type is must_use is to check the source for that type. Rustdoc should probably provide some sort of label for this to make such types easier to identify. This makes the documentation more explicit.
@sfackler sfackler added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 21, 2014
@tomjakubowski
Copy link
Contributor

Would it be sufficient to add #[must_use] to the definition (in the code block) here? http://doc.rust-lang.org/std/result/enum.Result.html

@aatxe
Copy link
Member Author

aatxe commented Dec 22, 2014

Yeah, that'd be fair.

@sanxiyn sanxiyn mentioned this issue Feb 12, 2015
Merged
steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 13, 2015
@steveklabnik
Rollup merge of rust-lang#22224 - sanxiyn:must-use, r=cmr
6f03875 
Fix rust-lang#20109.
steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 14, 2015
@steveklabnik
Rollup merge of rust-lang#22224 - sanxiyn:must-use, r=cmr
16d050c 
Fix rust-lang#20109.
steveklabnik added a commit to steveklabnik/rust that referenced this issue Feb 15, 2015
@steveklabnik
Rollup merge of rust-lang#22224 - sanxiyn:must-use, r=cmr
f5a2dff 
Fix rust-lang#20109.
Manishearth added a commit to Manishearth/rust that referenced this issue Feb 15, 2015
@Manishearth
Rollup merge of rust-lang#22224 - sanxiyn:must-use, r=cmr
132b56c 
Fix rust-lang#20109.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: Show must_use attribute sanxiyn/rust
3 participants
@tomjakubowski @aatxe @sfackler