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 #121

Merged
merged 25 commits into from
Jan 30, 2024
Merged

add docstrings #121

merged 25 commits into from
Jan 30, 2024

Conversation

cbyrohl
Copy link
Owner

@cbyrohl cbyrohl commented Dec 12, 2023

Add docstrings to all functions. Also fixes #99 and #118.

Copy link

codecov bot commented Dec 12, 2023

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (4efcb95) 54.84% compared to head (e32bec6) 54.82%.

Files Patch % Lines
src/scida/misc.py 38.46% 8 Missing ⚠️
src/scida/fields.py 70.58% 3 Missing and 2 partials ⚠️
src/scida/convenience.py 0.00% 1 Missing ⚠️
src/scida/customs/arepo/dataset.py 80.00% 1 Missing ⚠️
src/scida/customs/swift/series.py 0.00% 1 Missing ⚠️
src/scida/interfaces/mixins/spatial.py 0.00% 1 Missing ⚠️
src/scida/series.py 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #121      +/-   ##
==========================================
- Coverage   54.84%   54.82%   -0.02%     
==========================================
  Files          63       63              
  Lines        5742     5742              
  Branches     1139     1140       +1     
==========================================
- Hits         3149     3148       -1     
  Misses       2353     2353              
- Partials      240      241       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cbyrohl cbyrohl changed the title series/utilities docstrings add docstrings Jan 2, 2024
@cbyrohl cbyrohl mentioned this pull request Jan 29, 2024
@cbyrohl cbyrohl mentioned this pull request Jan 30, 2024
@cbyrohl cbyrohl merged commit 1ab7d5a into main Jan 30, 2024
4 of 5 checks passed
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.

API doc for scida.load()
1 participant