Type hints, test building docs #210
Draft
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
bastelfreak
reviewed
Apr 17, 2021
when building docs by treating warnings as errors (like readthedocs does).
and remove the :type entries from their docstrings thanks to the sphinx-autodoc-typehints extension. Also complete their docstrings for their constructors and the static creation methods.
"WARNING: more than one target found for cross-reference 'facts': pypuppetdb.api.QueryAPI.facts, pypuppetdb.types.Node.facts" See https://stackoverflow.com/a/67137409/2693875.
even though it's a RC1 as of now
Codecov Report
@@ Coverage Diff @@
## master #210 +/- ##
==========================================
+ Coverage 84.96% 85.03% +0.07%
==========================================
Files 14 14
Lines 918 929 +11
==========================================
+ Hits 780 790 +10
- Misses 138 139 +1
Continue to review full report at Codecov.
|
|
Partially done in #220. |
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.
Instead of declaring types in the docstrings let's use PEP 484 type hints. Thanks to the sphinx-autodoc-typehints extension they will be added to the docs but also work as static types to add type safety to this library.
Also add a GitHub Action doc building test to avoid getting commits like 6c8c3a8 that are breaking docs building (https://readthedocs.org/projects/pypuppetdb/builds/13531565/) getting into the master branch.