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

SurvivalProbabilty Docs #4248

Merged
merged 1 commit into from
Aug 22, 2023
Merged

SurvivalProbabilty Docs #4248

merged 1 commit into from
Aug 22, 2023

Conversation

jaclark5
Copy link
Contributor

@jaclark5 jaclark5 commented Aug 16, 2023

Fixes #4247

Changes made in this Pull Request:

  • Updated docs for SurvivalProbabilty function.

PR Checklist

  • [NA] Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

Developers certificate of origin


📚 Documentation preview 📚: https://mdanalysis--4248.org.readthedocs.build/en/4248/

@github-actions
Copy link

github-actions bot commented Aug 16, 2023

Linter Bot Results:

Hi @jaclark5! Thanks for making this PR. We linted your code and found the following:

Some issues were found with the formatting of your code.

Code Location Outcome
main package ⚠️ Possible failure
testsuite ✅ Passed

Please have a look at the darker-main-code and darker-test-code steps here for more details: https://github.com/MDAnalysis/mdanalysis/actions/runs/5884082397/job/15958077997


Please note: The black linter is purely informational, you can safely ignore these outcomes if there are no flake8 failures!

@codecov
Copy link

codecov bot commented Aug 16, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.01% 🎉

Comparison is base (acfd122) 93.40% compared to head (c5ae4bd) 93.41%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4248      +/-   ##
===========================================
+ Coverage    93.40%   93.41%   +0.01%     
===========================================
  Files          169      183      +14     
  Lines        22204    23309    +1105     
  Branches      4064     4064              
===========================================
+ Hits         20740    21775    +1035     
- Misses         948     1018      +70     
  Partials       516      516              
Files Changed Coverage Δ
package/MDAnalysis/analysis/waterdynamics.py 93.01% <ø> (ø)

... and 14 files with indirect coverage changes

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

Copy link
Member

@hmacdope hmacdope left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this @jaclark5, much better with the ensemble average marked clearly. :)

@hmacdope hmacdope requested a review from RMeli August 21, 2023 06:23
@hmacdope hmacdope merged commit 8923c4a into MDAnalysis:develop Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclear documentation for SurvivalProbability function
4 participants