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 user docs #58

Merged
merged 5 commits into from
Jan 8, 2025
Merged

Add user docs #58

merged 5 commits into from
Jan 8, 2025

Conversation

mdoucet
Copy link
Member

@mdoucet mdoucet commented Jan 7, 2025

Add user documentation that describes how to use the module.

@mdoucet mdoucet marked this pull request as draft January 7, 2025 22:08
@codecov-commenter
Copy link

codecov-commenter commented Jan 7, 2025

Codecov Report

Attention: Patch coverage is 86.80203% with 26 lines in your changes missing coverage. Please review.

Project coverage is 85.77%. Comparing base (81e811a) to head (122769d).
Report is 33 commits behind head on next.

Files with missing lines Patch % Lines
reduction/lr_reduction/template.py 71.21% 19 Missing ⚠️
...eduction/lr_reduction/reduction_template_reader.py 90.69% 4 Missing ⚠️
reduction/lr_reduction/time_resolved.py 93.61% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             next      #58      +/-   ##
==========================================
- Coverage   85.87%   85.77%   -0.10%     
==========================================
  Files          20       21       +1     
  Lines        2478     2475       -3     
==========================================
- Hits         2128     2123       -5     
- Misses        350      352       +2     

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

@mdoucet mdoucet marked this pull request as ready for review January 8, 2025 17:54
@mdoucet mdoucet merged commit f900928 into next Jan 8, 2025
1 check passed
@mdoucet mdoucet deleted the user-docs branch January 8, 2025 22:01
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.

2 participants