rustdoc book: talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] #45767
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
|
r? @frewsxcv (rust_highfive has picked a reviewer for you, use r? to override) |
kennytm
added
the
S-waiting-on-review
|
poke @frewsxcv — haven't heard from you in a while! |
frewsxcv
approved these changes
Nov 17, 2017
|
@bors r+ rollup |
|
📌 Commit ce7a3a4 has been approved by |
kennytm
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Nov 18, 2017
…ol, r=frewsxcv rustdoc book: talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] While investigating rust-lang#45750 i noticed that `#![doc(test(attr(...)))]` wasn't documented at all. Since this is useful for making your examples follow the same coding guidelines as your code, i wanted to add it to the Rustdoc Book. I also added `#![doc(test(no_crate_inject))]` since it's used in the same place and might be useful for macro-heavy crates. I added mentions for these to "The `doc` attribute" as well as "Documentation tests" since it's useful information in both places. Technically the step reordering in the second commit is gated on rust-lang#45764, since before that lands attributes from the doctest come before the ones from `#![doc(test(attr(...)))]`.
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.
While investigating #45750 i noticed that
#![doc(test(attr(...)))]wasn't documented at all. Since this is useful for making your examples follow the same coding guidelines as your code, i wanted to add it to the Rustdoc Book. I also added#![doc(test(no_crate_inject))]since it's used in the same place and might be useful for macro-heavy crates. I added mentions for these to "Thedocattribute" as well as "Documentation tests" since it's useful information in both places.Technically the step reordering in the second commit is gated on #45764, since before that lands attributes from the doctest come before the ones from
#![doc(test(attr(...)))].