EducationalTestingService / skll

SciKit-Learn Laboratory (SKLL) makes it easy to run machine learning experiments.
http://skll.readthedocs.org
Other
550 stars 69 forks source link

Improve docstrings and create linkable type hints (Part 1) #737

Closed desilinguist closed 1 year ago

desilinguist commented 1 year ago

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.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (0a4381a) 95.21% compared to head (9ef3f53) 95.21%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #737 +/- ## ======================================= Coverage 95.21% 95.21% ======================================= Files 29 29 Lines 3531 3532 +1 ======================================= + Hits 3362 3363 +1 Misses 169 169 ``` | [Impacted Files](https://app.codecov.io/gh/EducationalTestingService/skll/pull/737?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService) | Coverage Δ | | |---|---|---| | [skll/config/\_\_init\_\_.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/737?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9jb25maWcvX19pbml0X18ucHk=) | `94.75% <ø> (ø)` | | | [skll/config/utils.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/737?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC9jb25maWcvdXRpbHMucHk=) | `96.15% <ø> (ø)` | | | [skll/types.py](https://app.codecov.io/gh/EducationalTestingService/skll/pull/737?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=EducationalTestingService#diff-c2tsbC90eXBlcy5weQ==) | `92.59% <100.00%> (+0.28%)` | :arrow_up: |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.