-
Couldn't load subscription status.
- Fork 13.9k
rustdoc: Test & document test_harness code block attribute
#148183
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
base: master
Are you sure you want to change the base?
rustdoc: Test & document test_harness code block attribute
#148183
Conversation
|
rustbot has assigned @GuillaumeGomez. Use |
| None, | ||
| Some(Vec<String>), | ||
| } | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not any old ENBF1 (variant), it's ABNF2 specifically (from IETF RFC 5234) which I previously didn't know about (and thus was confused about the syntax).
Footnotes
| /// delimited-attribute-list = OPEN-CURLY-BRACKET attribute-list CLOSE-CURLY-BRACKET | ||
| /// token-list = [sep] token *(sep token) [sep] | ||
| /// comment = OPEN_PAREN *(all characters) CLOSE_PAREN | ||
| /// comment = OPEN_PAREN *<all characters except closing parentheses> CLOSE_PAREN |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prose terminals are to be denoted by <…> not by (…) (which is grouping) per IETF RFC 5234 (Ctrl+F for prose-val).
eab1d61 to
5e7f083
Compare
This comment has been minimized.
This comment has been minimized.
5e7f083 to
c687f89
Compare
This comment has been minimized.
This comment has been minimized.
c687f89 to
f71d897
Compare
This comment has been minimized.
This comment has been minimized.
f71d897 to
9a78729
Compare
|
The job Click to see the possible cause of the failure (guessed by this bot) |
They were fully untested and undocumented previously despite being stable.
Context: #t-rustdoc > `test_harness` langstr @ 💬.
While at it, I've also improved the documentation for code block attributes in general.
I was only inspired to do so because there was no good place for
test_harnessand because it got hard to skim due to a lack of subsubsections.