Fix missing backtick in doc comments letting markdown think &[u8] is a link to u8 #1119
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
titaniumtraveler
changed the title
This was leading to rustdocs markdown parser to interpret slices like &[u8] as & and a link to u8
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.
While reading the documentation/the source code (for the purpose of creating my own
Deserializerfor a different format) I found that inserde_json::de::Read&[u8]was rendered incorrectly.So I did a quick
grepand fixed all I could find by adding backticks.I also switching the
&[u8]in theREADME.md/src/lib.rsfrom escapes to backticks for consistency sake.(I assume the
README.mdwas generated from thesrc/lib.rswith some tool, but if both are changed the same way, it should still be consistent with the output.)