Skip to content

DocFix: Added the documentation for run() method for HydrogenBondAnalysis()#4917

Merged
RMeli merged 3 commits intoMDAnalysis:developfrom
jauy123:develop
Feb 19, 2025
Merged

DocFix: Added the documentation for run() method for HydrogenBondAnalysis()#4917
RMeli merged 3 commits intoMDAnalysis:developfrom
jauy123:develop

Conversation

@jauy123
Copy link
Copy Markdown
Contributor

@jauy123 jauy123 commented Feb 18, 2025

Changes made in this Pull Request:

  • added :inherited-members: run attribute to HydrogenBondAnalysis()'s autoclass, so that BaseAnalysis.run() is visible for HydrogenBondAnalysis() in the MDAnalysis Documentation.

Developers Certificate of Origin


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

Copy link
Copy Markdown

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello there first time contributor! Welcome to the MDAnalysis community! We ask that all contributors abide by our Code of Conduct and that first time contributors introduce themselves on GitHub Discussions so we can get to know you. You can learn more about participating here. Please also add yourself to package/AUTHORS as part of this PR.

@jauy123
Copy link
Copy Markdown
Contributor Author

jauy123 commented Feb 18, 2025

I have done this per our discussion earlier today @orbeckst

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.64%. Comparing base (b79c77d) to head (1c7b17d).
Report is 28 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4917      +/-   ##
===========================================
- Coverage    93.66%   93.64%   -0.03%     
===========================================
  Files          177      189      +12     
  Lines        21850    22916    +1066     
  Branches      3079     3079              
===========================================
+ Hits         20466    21459     +993     
- Misses         933     1006      +73     
  Partials       451      451              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@RMeli RMeli left a comment

Choose a reason for hiding this comment

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

Please also add your GitHub handle to the CHANGELOG. Otherwise looks good to me, thank you!

@jauy123
Copy link
Copy Markdown
Contributor Author

jauy123 commented Feb 19, 2025

I just added my handle! Thank you!

@RMeli RMeli merged commit 6f8d875 into MDAnalysis:develop Feb 19, 2025
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