Fix some docstrings #198
Merged
Fix some docstrings #198
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 @@
## master #198 +/- ##
==========================================
- Coverage 95.26% 95.10% -0.17%
==========================================
Files 23 23
Lines 1226 1226
Branches 276 276
==========================================
- Hits 1168 1166 -2
- Misses 33 34 +1
- Partials 25 26 +1
|
|
This library was written before type annotations were available in all versions of Python, so it makes sense at this stage to remove a lot of the docstring types and annotate the functions correctly then use mypy or pyright to do the validation. For now, I'll bring this one in, thanks for the update |
tonybaloney
approved these changes
Jul 17, 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.
Fix some docstrings for correct description, typos, typing information, consistency, etc.
For typing information, the docstring was updated to what is in code, but we could instead fix the code where it makes sense: e.g. when the docstring expects a the name of the Archiver (a str) but an Archiver is passed instead, we could actually pass the name. I'm willing to fix it either way.