Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.
Sign upTreat "Failure" and "Safety note" doc comments specially in generated docs #6759
Comments
This comment has been minimized.
This comment has been minimized.
|
Visiting for triage. /cc @cmr. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
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. |
This comment has been minimized.
This comment has been minimized.
|
cc me |
This comment has been minimized.
This comment has been minimized.
|
We now have |
steveklabnik
removed
the
A-docs
label
Feb 13, 2015
This comment has been minimized.
This comment has been minimized.
|
Triage: no change here. |
This comment has been minimized.
This comment has been minimized.
|
Using headings is very unsatisfactory. I prefer |
steveklabnik
added
the
T-tools
label
Mar 9, 2017
steveklabnik
removed
the
A-tools
label
Mar 24, 2017
steveklabnik
added
T-dev-tools
and removed
T-tools
labels
May 18, 2017
This comment has been minimized.
This comment has been minimized.
|
Triage: no changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
lkuper commentedMay 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.