-
Notifications
You must be signed in to change notification settings - Fork 4
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
Improve the documentation of ensemble_md
#46
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #46 +/- ##
==========================================
- Coverage 96.10% 96.08% -0.03%
==========================================
Files 10 10
Lines 1950 1914 -36
==========================================
- Hits 1874 1839 -35
+ Misses 76 75 -1 ☔ View full report in Codecov by Sentry. |
Refactor some utility functions
I renamed the branch from |
Okay, it seems that changing the branch is not possible so I am going to open another new PR to include the work here. See Issue #48. |
This PR aims to address the todos listed in the section "Improving the documentation" in issue #41, which includes the following tasks:
- [ ] Update the theory section of the documentation- [ ] Describe rules of thumb for REXEE parameters- [ ] Proofread the entire documentationFor a complete list of modules for docstrings proofreading, please visit issue #43.