std: Document builtin syntax extensions #13255
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// These macros do not have any corresponding definition with a `macro_rules!` | ||
| /// macro, but are documented here. Their implementations can be found hardcoded | ||
| /// into libsyntax itself. | ||
| #[cfg(dox)] |
There was a problem hiding this comment.
I like the name dox, and it's essentially invisible to anyone but those working on libstd.
|
Updated with comments addressed |
| /// This macro takes any number of comma-separated identifiers, and | ||
| /// concatenates them all into one, yielding an expression which is a new | ||
| /// identifier. Note that hygiene makes it such that this macro cannot | ||
| /// capture local variables. |
There was a problem hiding this comment.
" and macros are only allowed in item, statement or expression position, meaning this macro can rarely be used."
There was a problem hiding this comment.
(Maybe we should feature-gate concat_idents?)
|
(Oh, forgot to say: r=me with comments.) |
These syntax extensions need a place to be documented, and this starts passing a `--cfg dox` parameter to `rustdoc` when building and testing documentation in order to document macros so that they have no effect on the compiled crate, but only documentation. Closes rust-lang#5605
bors
added a commit
that referenced
this pull request
Apr 4, 2014
These syntax extensions need a place to be documented, and this starts passing a `--cfg dox` parameter to `rustdoc` when building and testing documentation in order to document macros so that they have no effect on the compiled crate, but only documentation. Closes #5605
|
I find your obsession with "dox" unhealthy. |
Jarcho
pushed a commit
to Jarcho/rust
that referenced
this pull request
Aug 24, 2024
Remove more `snippet_opt` calls First commit is the same as rust-lang#13244 changelog: none
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These syntax extensions need a place to be documented, and this starts passing a
--cfg doxparameter torustdocwhen building and testing documentation inorder to document macros so that they have no effect on the compiled crate, but
only documentation.
Closes #5605