Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docstrings and type hints (Part 3) #739

Merged
merged 5 commits into from Jun 14, 2023

Conversation

desilinguist
Copy link
Member

  • chore: ignore E501 errors in various files.
  • chore: fix docstrings and types in skll.experiments and skll.learner modules.

To review this, please look at the built documentation and check that under "API documentation", look at the sections "experiments Package" and "learner Package" and confirm that:

  • All parameters have a docstring.
  • All type hints have clickable types or type hints.
  • The default values are all specified as default = blah.
  • All other changes look okay.

This is part of #647.

@codecov
Copy link

codecov bot commented Jun 13, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b8be359) 95.18% compared to head (6737a7b) 95.19%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #739   +/-   ##
=======================================
  Coverage   95.18%   95.19%           
=======================================
  Files          29       29           
  Lines        3533     3535    +2     
=======================================
+ Hits         3363     3365    +2     
  Misses        170      170           
Impacted Files Coverage Δ
skll/data/readers.py 90.42% <ø> (ø)
skll/data/writers.py 93.20% <ø> (ø)
skll/experiments/input.py 100.00% <ø> (ø)
skll/experiments/utils.py 93.38% <ø> (ø)
skll/learner/__init__.py 97.18% <ø> (ø)
skll/learner/utils.py 93.31% <ø> (ø)
skll/learner/voting.py 98.54% <ø> (ø)
skll/experiments/__init__.py 94.69% <100.00%> (+0.01%) ⬆️
skll/experiments/output.py 97.46% <100.00%> (+0.01%) ⬆️

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

Copy link

@damien2012eng damien2012eng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@desilinguist desilinguist merged commit 6409e06 into main Jun 14, 2023
10 checks passed
@delete-merged-branch delete-merged-branch bot deleted the 647-improve-docstrings-typehints-3 branch June 14, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants