Fix a couple syntax errors in documentation #131
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
This snippet of documentation was in an .rst file and should have been in Restructured Text syntax, but it was actually in Markdown, so it wasn't rendering properly in the final documentation. I'm fixing that with this commit. It would be nice if we had a pre-commit hook to check .rst syntax, it probably would have caught this, but I haven't found a really good hook for that yet.
I used the wrong link syntax in a docstring, so I'm fixing that here. This is another case where a suitable pre-commit hook would have helped, though in this case we'd need one able to check RST syntax in docstrings specifically. I'm not sure if there is a good hook that does that.
sjlongland
approved these changes
Dec 10, 2023
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.
Fairly straightforward, just fixing a couple of errors. In both cases I lamented the lack of a good pre-commit hook to catch this sort of thing, so maybe we can find one and add it in the future.
Closes #129
Closes #130