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

Addition of water selection documentation #4881

Merged
merged 3 commits into from
Jan 6, 2025

Conversation

talagayev
Copy link
Member

@talagayev talagayev commented Jan 4, 2025

Fixes #4880

Changes made in this Pull Request:

  • Addition of water keyword description in selections.rst

I would assume since it is a short PR fix that is connected to #4854 there is no necessity for an modification of
the CHANGELOG and creation of a new mention for this short fix, although I could add the mention of this PR in the line where I mention the implementation of the water token in the first place, if this is prefered

PR Checklist

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

Developers certificate of origin


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

addition of water in simple selection with its description
Copy link

codecov bot commented Jan 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.64%. Comparing base (2844005) to head (7259197).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4881      +/-   ##
===========================================
- Coverage    93.65%   93.64%   -0.02%     
===========================================
  Files          177      189      +12     
  Lines        21796    22862    +1066     
  Branches      3067     3067              
===========================================
+ Hits         20414    21408     +994     
- Misses         929     1002      +73     
+ Partials       453      452       -1     

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

@RMeli RMeli requested review from RMeli, IAlibay and hmacdope January 4, 2025 21:37
added mention of all available resnames for water that are recognized
@talagayev talagayev requested a review from hmacdope January 5, 2025 01:55
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.

LGTM! Thanks.

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Overall the content looks good to me, but I would like to checkout the render, unfortunately that seems to be failing. Will just block whilst we try to fix the RTD build.

is defined with a set of common water abbreviations present in
topology files and may not work with certain water residue names.
Currently the following water resnames are supported:
3 letter resnames: ``H2O``, ``HOH``, ``OH2``, ``HHO``, ``OHH``, ``TIP``,
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure this will render out amazingly well - unfortunately the docs build seems to have failed.

@IAlibay
Copy link
Member

IAlibay commented Jan 6, 2025

Cycling the PR to see if we can get RTD to rebuild.

@IAlibay IAlibay closed this Jan 6, 2025
@IAlibay IAlibay reopened this Jan 6, 2025
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Just the one thing.

@IAlibay IAlibay merged commit 536a390 into MDAnalysis:develop Jan 6, 2025
13 of 22 checks passed
@talagayev
Copy link
Member Author

Perfect, thanks for looking into the PR @hmacdope and @IAlibay.

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.

Document water selection keyword
3 participants