kvs: add rst format to inline docs #6503
Open
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
Problem: on the web version of the docs, which are auto-generated, multiple lines of python appear on the same line, and are formatted weirdly. We can add rst format to the inline docs.
wihobbs
force-pushed
the
rst-inline-doc
branch
from
d8c4ec7 to
81a9eba
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6503 +/- ##
==========================================
- Coverage 83.63% 83.62% -0.02%
==========================================
Files 525 525
Lines 87682 87682
==========================================
- Hits 73334 73322 -12
- Misses 14348 14360 +12
|
it doesn't really bother me.. Does it work if you just use The other solution I've seen is to use inline doctest markers, e.g. though I guess in that case it should be more of a full example? (e.g. |
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 might be a problem other places too.
What renders:
After this PR:
Is this really what we want? RST shoved in our python in-line docs? I'm not sure...