Clarify unused_doc_comments note on macro invocations #71412
Merged
Conversation
This file contains hidden or 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
rust-highfive
added
the
S-waiting-on-review
yaahc
approved these changes
Apr 22, 2020
|
@bors r+ |
|
📌 Commit 3a8097f has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Apr 22, 2020
Rollup of 6 pull requests Successful merges: - rust-lang#70970 (Detect mistyped associated consts in `Instance::resolve`.) - rust-lang#71203 (Correct await span for async-await error reporting) - rust-lang#71214 (Add error code for inner doc error) - rust-lang#71337 (Moving all rustdoc-ui tests to check-pass) - rust-lang#71412 (Clarify unused_doc_comments note on macro invocations) - rust-lang#71414 (More diagnostic items for Clippy usage) Failed merges: r? @ghost
dtolnay
added
T-rustdoc
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
The previous error message used to say:
Obviously we do generate documentation for macros, such as https://docs.rs/bitflags/1.2.1/bitflags/macro.bitflags.html. It's only macro invocations that don't get their own docs. This PR updates the message to say "rustdoc does not generate documentation for macro invocations".
I observe that prior to #69084 this used to say "rustdoc does not generate documentation for macro expansions", as implemented originally in #57882. I don't have a preference between those but I made the commit before looking up the history.
r? @Manishearth
attn: @yaahc @euclio