Misc. API doc fixes #896
Merged
Misc. API doc fixes #896
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
huddlej
reviewed
May 3, 2022
There was a problem hiding this comment.
Thank you for fixing all of these glaring errors, @joverlee521! I noticed one weird parsing issue that remains, but after that's fixed, this is good to merge.
1. Add an extra line between sections and doctests to correctly render the doctest blocks 2. Add literal blocks using `::` to preserve formatting of example files 3. Correct `Returns` subtitles
Codecov Report
@@ Coverage Diff @@
## master #896 +/- ##
==========================================
+ Coverage 34.62% 35.07% +0.45%
==========================================
Files 42 42
Lines 6007 6052 +45
Branches 1538 1557 +19
==========================================
+ Hits 2080 2123 +43
Misses 3854 3854
- Partials 73 75 +2
Continue to review full report at Codecov.
|
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.
Miscellaneous API doc fixes that came from my dive into rST and the API docs when I was working on the measurements subcommand.
These commits were originally part of #879, but split into this new PR at the request of @huddlej for easier review.