fix: missing closing backtick in gix lib documentation #1325
+2
−2
Conversation
This file contains hidden or 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
|
Since I was already making this edit and I had an open PR, I found another case where a missing backtick caused the incorrect formatting behavior to occur when documenting the Mutually Exclusive Network Client section. This time instead of missing the closing backtick, the opening one was missing. I took the liberty and just included a fix into this similar PR.
Hope it helps! |
Byron
approved these changes
Mar 19, 2024
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.
This is a silly and very simple change to just correct a formatting mistake in the documentation of the
gixcrate.You can see the formatting error on the docs.rs documentation. Put simply, an opening backtick was opened and never closed, this PR correct the issue by adding the closing backtick.