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

Treat "Failure" and "Safety note" doc comments specially in generated docs #6759

Closed
lkuper opened this issue May 27, 2013 · 9 comments
Closed

Treat "Failure" and "Safety note" doc comments specially in generated docs #6759

lkuper opened this issue May 27, 2013 · 9 comments
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. 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

@lkuper
Copy link
Contributor

lkuper commented May 27, 2013

As noted on rust-dev, it's easy for these comments to blend too easily into the surrounding documentation. Something like a "watch out for this!" icon could help.
@huonw
Copy link
Member

huonw commented Jul 23, 2013

Visiting for triage. /cc @cmr.

@emberian
Copy link
Member

#8125

/cc @Seldaek

@emberian
Copy link
Member

emberian commented Jan 6, 2014

So I'm going to defer this for a while. If we decide to use reST, like I would love to, this would be easily handled by a directive.

cc @chris-morgan

@Gankra
Copy link
Contributor

Gankra commented Aug 8, 2014

cc me

@steveklabnik
Copy link
Member

We now have # Panics for this.

@steveklabnik
Copy link
Member

Triage: no change here.

@bluss
Copy link
Member

bluss commented Mar 5, 2016

Using headings is very unsatisfactory. I prefer **Panics** if you blah.

@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
@QuietMisdreavus QuietMisdreavus mentioned this issue Aug 7, 2017
Open
@steveklabnik
Copy link
Member

Triage: no changes.

@Mark-Simulacrum
Copy link
Member

I think we shouldn't really do anything here, and it seems like if we decide to do something we can open an actionable issue and/or try it out by manually doing it -- closing.

flip1995 pushed a commit to flip1995/rust that referenced this issue Feb 25, 2021
@bors
Auto merge of rust-lang#6759 - Y-Nak:fix-fp-of-result_unit_err, r=llogiq
7d535f6 
Fix FP of result_unit_err when using type aliases

fixes rust-lang#6546

changelog: none
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. 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
Milestone
No milestone
Development

No branches or pull requests
7 participants
@steveklabnik @lkuper @emberian @Gankra @huonw @bluss @Mark-Simulacrum