This repository has been archived by the owner on Jul 8, 2021. It is now read-only.
Hide docstrings in included source code #50
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
Codecov Report
@@ Coverage Diff @@
## pyspec #50 +/- ##
==========================================
- Coverage 94.90% 94.89% -0.01%
==========================================
Files 13 13
Lines 746 745 -1
==========================================
- Hits 708 707 -1
Misses 38 38
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
lightclient
approved these changes
Jun 28, 2021
There was a problem hiding this comment.
Generally look good to me. I was having the following error generating the docs though:
eth1.0-specs/doc/autoapi/eth1spec/crypto/index.rst:55:'Str' object has no attribute 'end_lineno'
Should probably figure that out before merging. Nice job on the module though, looks great :)
Yeah, I'll fix that and be back! |
Since the docstrings are rendered as HTML, there's really no reason to include them in the code snippets. This commit adds a dependency on undocliteral, a hacky tool to strip docstrings when using literalinclude. This commit also removes the types from parameters in docstrings. The signatures are annotated and checked with mypy, so including the types in the docstrings is just duplicated information that can get out of sync.
|
Awesome! Look great on my end. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What was wrong?
Closes #26, plus assorted other small documentation fixes.
Also, documenting the types of parameters is redundant, so removed all that. Have to still document return types or else it doesn't parse correctly.
How was it fixed?
Created a hacked
literalincludedirective that parses and excludes docstrings.Cute Animal Picture