fix(docs): enclose inline code in backticks #170
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
pksunkara
approved these changes
Apr 24, 2024
|
@LeoniePhiline I think we'll land 163 then you can go ahead and rebase on master |
|
turns out I was able to do the rebase myself easily ^_^ |
|
Thank you! |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Fixes #169
Besides enclosing inline code in backticks, I also made two tiny documentation improvements - please let me know if you want them undone:
Report::msgdocs, the user is referred toReport::new. I changed this from plain inline code into a link.Displayimpl" to "Displayimplementation", sinceimplis a Rust token, butDisplayimpl" looked silly, andimpl Display" disturbed the flow of reading.