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

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

Open
lkuper opened this Issue May 27, 2013 · 8 comments

Comments

Projects
None yet
6 participants
@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

This comment has been minimized.

Copy link
Member

huonw commented Jul 23, 2013

Visiting for triage. /cc @cmr.

@cmr

This comment has been minimized.

Copy link
Member

cmr commented Aug 15, 2013

@cmr

This comment has been minimized.

Copy link
Member

cmr 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

@Gankro

This comment has been minimized.

Copy link
Contributor

Gankro commented Aug 8, 2014

cc me

@steveklabnik

This comment has been minimized.

Copy link
Member

steveklabnik commented Dec 8, 2014

We now have # Panics for this.

@steveklabnik steveklabnik removed the A-docs label Feb 13, 2015

@steveklabnik

This comment has been minimized.

Copy link
Member

steveklabnik commented Mar 4, 2016

Triage: no change here.

@bluss

This comment has been minimized.

Copy link
Contributor

bluss commented Mar 5, 2016

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

@steveklabnik

This comment has been minimized.

Copy link
Member

steveklabnik commented Sep 24, 2018

Triage: no changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.