Skip to content

Improve docstrings & type hints (Part 4) #740

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 2 commits into from
Jun 14, 2023
Merged

Improve docstrings & type hints (Part 4) #740

desilinguist merged 2 commits into from
Jun 14, 2023

Conversation

@desilinguist
Copy link
Collaborator

@desilinguist desilinguist commented Jun 14, 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 "metrics Package" and "utils 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 the final PR for #647. Closes #647.

@codecov
Copy link

codecov bot commented Jun 14, 2023 •
edited
Loading

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (6409e06) 95.19% compared to head (89b4543) 95.19%.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #740   +/-   ##
=======================================
  Coverage   95.19%   95.19%           
=======================================
  Files          29       29           
  Lines        3535     3535           
=======================================
  Hits         3365     3365           
  Misses        170      170
Impacted Files Coverage Δ
skll/learner/__init__.py 97.18% <ø> (ø)
skll/metrics.py 97.08% <ø> (ø)
...utils/commandline/compute_eval_from_predictions.py 97.50% <ø> (ø)
skll/utils/commandline/filter_features.py 98.50% <ø> (ø)
skll/utils/commandline/generate_predictions.py 98.68% <ø> (ø)
skll/utils/commandline/join_features.py 98.18% <ø> (ø)
skll/utils/commandline/plot_learning_curves.py 96.42% <ø> (ø)
skll/utils/commandline/print_model_weights.py 95.00% <ø> (ø)
skll/utils/commandline/run_experiment.py 96.87% <ø> (ø)
skll/utils/commandline/skll_convert.py 93.15% <ø> (ø)
... and 2 more

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

@desilinguist desilinguist merged commit c0ebc36 into main Jun 14, 2023
@delete-merged-branch delete-merged-branch bot deleted the 647-improve-docstrings-typehints-4 branch June 14, 2023 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dblandan dblandan dblandan approved these changes

@Frost45 Frost45 Frost45 approved these changes

@mulhod mulhod Awaiting requested review from mulhod

@damien2012eng damien2012eng Awaiting requested review from damien2012eng

@tamarl08 tamarl08 Awaiting requested review from tamarl08

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Rewrite docstrings to match scikit-learn style and show type hints correctly.

4 participants

@desilinguist @dblandan @Frost45