Skip to content

Improve docstrings and type hints (Part 3) #739

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.

Sign up for GitHub

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

Jump to bottom
Merged
desilinguist merged 5 commits into from
Jun 14, 2023
Merged

Improve docstrings and type hints (Part 3) #739

desilinguist merged 5 commits into from
Jun 14, 2023

Conversation

@desilinguist
Copy link
Collaborator

@desilinguist desilinguist commented Jun 13, 2023

  • 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 •
edited
Loading

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.

damien2012eng
damien2012eng reviewed Jun 14, 2023
View reviewed changes
damien2012eng
damien2012eng approved these changes Jun 14, 2023
View reviewed changes
Copy link
Member

@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
@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

Reviewers

@damien2012eng damien2012eng damien2012eng approved these changes

@dblandan dblandan Awaiting requested review from dblandan

@Frost45 Frost45 Awaiting requested review from Frost45

@tamarl08 tamarl08 Awaiting requested review from tamarl08

+1 more reviewer

@mulhod mulhod mulhod approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@desilinguist @mulhod @damien2012eng