Improve docstrings and type hints (Part 2). #738
Merged
Conversation
This file contains hidden or 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
- The sidebar does not work properly with sphinx>=6.0.
- Also refactored the keyword arguments for many writers to be more explicit rather than using `**kwargs` everywhere.
Use individual `autoclass` items instead of one `automodule` item to make sure that `Reader` and `Writer` base classes are shown before all the other classes.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #738 +/- ##
==========================================
- Coverage 95.21% 95.18% -0.03%
==========================================
Files 29 29
Lines 3532 3533 +1
==========================================
Hits 3363 3363
- Misses 169 170 +1
☔ View full report in Codecov by Sentry. |
dblandan
reviewed
Jun 12, 2023
dblandan
reviewed
Jun 12, 2023
dblandan
approved these changes
Jun 12, 2023
Frost45
approved these changes
Jun 13, 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.
featureset.py.skll.data. Also refactored the keyword arguments for many writers to be more explicit rather than using**kwargseverywhere.api/data.rst. Use individualautoclassitems instead of oneautomoduleitem to make sure thatReaderandWriterbase classes are shown before all the other classes.To review this, please look at the built documentation and check that under the "API documentation" > "
dataPackage`":default = blah.This is part of #647.