error: use intra-doc link #2067
Closed
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
`ErrorLayer`'s docs linked to `SpanTrace` using a relative (`../`) path. This works out wrong for the public re-export of `ErrorLayer` in the crate root. Change to an intra-doc link which rustdoc knows to resolve whether rendering the doc comment for the crate root or for the mod actually defining `ErrorLayer`.
|
I had |
|
actually this kind of thing happens in a lot of places doesn't it |
|
let's not, in favor of #2068 |
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.
Motivation
ErrorLayer's docs link toSpanTraceusing a relative (../) path.This works out wrong for the public re-export of
ErrorLayerin thecrate root.
Solution
Change to an intra-doc link which rustdoc knows to resolve whether
rendering the doc comment for the crate root or for the mod actually
defining
ErrorLayer.