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

Add docstrings to Classes #23

Merged
merged 2 commits into from
Aug 29, 2023
Merged

Add docstrings to Classes #23

merged 2 commits into from
Aug 29, 2023

Conversation

kaitj
Copy link
Contributor

@kaitj kaitj commented Aug 28, 2023

Proposed changes
Adds in missing docstrings to existing classes and updates the exceptions to use automodule instead of autoclass

At the moment, this adds some additional labour of excluding the attributes so it doesn't repeat under parameters.

Types of changes
What types of changes does your code introduce? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other (if none of the other choices apply)

Checklist
Put an x in the boxes that apply. You can also fill these out after creating the PR. If you are unsure about any of the choices, don't hesitate to ask!

  • Changes have been tested to ensure that fix is effective or that a feature works.
  • Changes pass the unit tests
  • Code has been run through the poe quality task
  • I have included necessary documentation or comments (as necessary)
  • Any dependent changes have been merged and published

Notes
All PRs will undergo the unit testing before being reviewed. You may be requested to explain or make additional changes before the PR is accepted.

@kaitj kaitj added the documentation Improvements or additions to documentation label Aug 28, 2023
@github-actions github-actions bot requested a review from tkkuehn August 28, 2023 17:34
@codecov
Copy link

codecov bot commented Aug 28, 2023

Codecov Report

Merging #23 (4530d8a) into main (ba3147d) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #23   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          348       348           
=========================================
  Hits           348       348           
Components Coverage Δ
afids_utils/afids.py ∅ <ø> (∅)
afids_utils/ext 100.00% <ø> (ø)
afids_utils/transforms.py 100.00% <ø> (ø)

@kaitj kaitj merged commit 5b23f29 into afids:main Aug 29, 2023
6 checks passed
@kaitj kaitj deleted the docs/fix_docstrings branch August 29, 2023 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants