rustdoc: import cross-crate macros alongside everything else #51611
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) |
rust-highfive
added
the
S-waiting-on-review
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
hey look, macros properly link to the right place now
|
The job Click to expand the log.I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
ollie27
reviewed
Jun 18, 2018
src/librustdoc/clean/inline.rs
Outdated
| }; | ||
|
|
||
| let source = format!("macro_rules! {} {{\n{}}}", | ||
| def.ident.name.clean(cx), |
There was a problem hiding this comment.
This needs to use the name passed to try_inline so that things like pub use foo::foo_macro as bar_macro; will display bar_macro here.
There was a problem hiding this comment.
I wonder if this is something we need to do for other imports. None of them are using the imported name either, and IIRC we have other issues regarding imported structs using the wrong name in impl pages.
There was a problem hiding this comment.
I believe that's a different issue. The difference with macros is that the definition is being rendered here rather than in render.rs like all other item types.
|
r? @ollie27 (also, review ping!) |
|
r=me with a test for the renamed case. |
|
@ollie27 Sorry for the delay; I've pushed a commit which updates the test. |
|
@bors: r+ |
|
📌 Commit 61dc03c has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
that referenced
this pull request
Jul 4, 2018
rustdoc: import cross-crate macros alongside everything else The thrilling conclusion of the cross-crate macro saga in rustdoc! After #51425 made sure we saw all the namespaces of an import (and prevented us from losing the `vec!` macro in std's documentation), here is the PR to handle cross-crate macro re-exports at the same time as everything else. This way, attributes like `#[doc(hidden)]` and `#[doc(no_inline)]` can be used to control how the documentation for these macros is seen, rather than rustdoc inlining every macro every time. Fixes #50647
|
☀️ Test successful - status-appveyor, status-travis |
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.
The thrilling conclusion of the cross-crate macro saga in rustdoc! After #51425 made sure we saw all the namespaces of an import (and prevented us from losing the
vec!macro in std's documentation), here is the PR to handle cross-crate macro re-exports at the same time as everything else. This way, attributes like#[doc(hidden)]and#[doc(no_inline)]can be used to control how the documentation for these macros is seen, rather than rustdoc inlining every macro every time.Fixes #50647