Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign uprustdoc intra links: Module-level doc uses parent module's namespace instead of own #55364
Comments
This comment has been minimized.
This comment has been minimized.
|
I definitely agree with the motivation. One issue is what about outer-doc comments on a module? /// See either [foo] or [bar].
pub mod sub {
/// See [bar]
pub fn foo() {}
/// See [foo]
pub fn bar() {}
}I'm not sure if they're distinguishable to |
memoryruins
added
the
T-rustdoc
label
Oct 29, 2018
QuietMisdreavus
added
the
A-intra-doc-links
label
Nov 6, 2018
This comment has been minimized.
This comment has been minimized.
|
They are distinguishable, I recall I knowingly skipped this when implementing this feature because it was tricky to get right and I wasn't sure which way we wanted it to work. |
nrc
referenced this issue
Nov 27, 2018
Open
Tracking issue for RFC 1946 - intra-rustdoc links #43466
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
crumblingstatue commentedOct 25, 2018
I don't know if this is an accidental regression, or an intentional change, but this used to resolve.
I argue that module-level docs should have the same namespace as the module they are referring to, since referring to the items of the documented module is much more common than referring to items in the parent module.
Ref #43466