doc: Fix errors more prettily #127
Merged
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
Kijewski
reviewed
Sep 16, 2024
src/adc.rs
Outdated
| @@ -20,7 +20,7 @@ impl ADCLine { | |||
|
|
|||
| /// Initialize an ADC line identified by the line number it is assigned on the board | |||
| /// | |||
| /// Safety: See [Self::init()] | |||
| /// Safety: See [.init()](Self::init()) | |||
There was a problem hiding this comment.
In my experience, using [text][target] is more stable, because sometimes the target gets interpreted as a hyperlink, which does not happen with […][…]. https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html mentions the […][…] syntax, so it's no accident that it works.
chrysn
force-pushed
the
doc-fixes-more-properly
branch
from
875e429
to
7e76e2f
Compare
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.
Thanks @Kijewski for suggesting this in #126 (comment)