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

DocFix: Added the documentation for run() method in polymer.rst #4864

Merged
merged 1 commit into from
Jan 6, 2025

Conversation

tanishy7777
Copy link
Contributor

@tanishy7777 tanishy7777 commented Dec 24, 2024

Fixes #4793

Changes made in this Pull Request:

  • Added :inherited-members: to polymer.rst so that run method from AnaylsisBase is added in the documentation for MDAnalysis.analysis.polymer

PR Checklist

  • Tests?
  • Docs?
  • CHANGELOG updated?
  • Issue raised/referenced?

Developers certificate of origin


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

@tanishy7777
Copy link
Contributor Author

tanishy7777 commented Dec 24, 2024

Image of docs from readthedocs
image

Copy link

codecov bot commented Dec 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.63%. Comparing base (9110a6e) to head (3cc9021).
Report is 12 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4864      +/-   ##
===========================================
- Coverage    93.65%   93.63%   -0.03%     
===========================================
  Files          177      189      +12     
  Lines        21779    22845    +1066     
  Branches      3064     3064              
===========================================
+ Hits         20398    21391     +993     
- Misses         929     1002      +73     
  Partials       452      452              

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

@tanishy7777
Copy link
Contributor Author

@RMeli @orbeckst this seems ready to be merged in my opinion. Could you please review it?

@orbeckst orbeckst self-assigned this Jan 6, 2025
Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

lgtm – and you're already in AUTHORS/CHANGELOG.

@orbeckst orbeckst merged commit 0ac6981 into MDAnalysis:develop Jan 6, 2025
24 of 26 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.

[docs] MDAnalysis.analysis.polymer.PersistenceLength does not document run() method
2 participants