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.

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

#[must_use] attribute showing up in rustdoc output #37012

Closed
frewsxcv opened this issue Oct 7, 2016 · 5 comments
Closed

#[must_use] attribute showing up in rustdoc output #37012

frewsxcv opened this issue Oct 7, 2016 · 5 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@frewsxcv
Copy link
Member

frewsxcv commented Oct 7, 2016

https://doc.rust-lang.org/nightly/std/iter/struct.Cycle.html

screen shot 2016-10-06 at 8 06 34 pm

@durka
Copy link
Contributor

durka commented Oct 7, 2016

It always did. Is this bad? Maybe rustdoc should parse it and display it in a prettier way, like it does with #[unstable] and #[deprecated]?

@frewsxcv
Copy link
Member Author

frewsxcv commented Oct 7, 2016

Will bring this up at the next Rust doc meeting.

@ollie27
Copy link
Member

ollie27 commented Oct 7, 2016

Looks like this is intentional #22224. There is probably a better way of displaying it though.

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 7, 2016
@nagisa
Copy link
Member

nagisa commented Oct 7, 2016

We probably will want to show even more of these (e.g. the repr()) attributes. If showing it as a plain attribute is insufficient, the solution should be extensible.

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum Mark-Simulacrum added C-enhancement Category: An issue proposing an enhancement or a PR with one. C-feature-request Category: A feature request, i.e: not implemented / a PR. and removed C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Jul 26, 2017
@GuillaumeGomez
Copy link
Member

This issue has been fixed by hiding attributes by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

7 participants