Improve docstrings and create linkable type hints (Part 1) #737
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
- Clean out commented bits. - Add intersphinx mappings for python, numpy, scikit-learn, and pandas. - Enable type hints to be shown in docstrings.
- Convert all custom types to `TypeAlias` objects. - Sort alphabetically.
- Link all custom types in docstrings to their definitions. - Add type hints where missing.
- Add `typing_extensions` explicitly. - Update scikit-learn version in doc requirements.
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #737 +/- ##
=======================================
Coverage 95.21% 95.21%
=======================================
Files 29 29
Lines 3531 3532 +1
=======================================
+ Hits 3362 3363 +1
Misses 169 169
☔ View full report in Codecov by Sentry. |
dblandan
approved these changes
Jun 9, 2023
Frost45
approved these changes
Jun 9, 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.
skll.typestoTypeAliasobjects.typing_extensionstorequirements.txtsinceTypeAliasin only in Python 3.10+.doc/conf.py.skll.typesto the API documentation section by creating a new fileapi/types.rst.skll.configmodule to match scikit-learn style, add type hints to the docstrings, and link type hints to SKLL-internal documentation or to the appropriate external documentation.doc/requirements.txtto use newer versions ofsphinxandsphinx_rtd_theme.Here's the corresponding documentation built from this branch: https://skll.readthedocs.io/en/647-improve-docstrings-typehints-1/
This is the first PR under #647.