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

rustdoc book: talk about #![doc(test(no_crate_inject))] and #![doc(test(attr(...)))] #45767

Merged
merged 2 commits into from
Nov 18, 2017

Conversation

QuietMisdreavus
Copy link
Member

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 "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 #45764, since before that lands attributes from the doctest come before the ones from #![doc(test(attr(...)))].

@rust-highfive
Copy link
Collaborator

r? @frewsxcv

(rust_highfive has picked a reviewer for you, use r? to override)

@kennytm kennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 5, 2017
@shepmaster
Copy link
Member

poke @frewsxcv — haven't heard from you in a while!

Copy link
Member

@frewsxcv frewsxcv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for the delay here, this all look good to me, nice work! ✨

@frewsxcv
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Nov 17, 2017

📌 Commit ce7a3a4 has been approved by frewsxcv

@kennytm kennytm added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 17, 2017
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(...)))]`.
bors added a commit that referenced this pull request Nov 18, 2017
Rollup of 4 pull requests

- Successful merges: #45767, #46044, #46066, #46071
- Failed merges:
@bors bors merged commit ce7a3a4 into rust-lang:master Nov 18, 2017
@QuietMisdreavus QuietMisdreavus deleted the who-docs-the-doc-tool branch February 26, 2018 23:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants