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

Document water selection keyword #4880

Closed
IAlibay opened this issue Jan 3, 2025 · 2 comments · Fixed by #4881
Closed

Document water selection keyword #4880

IAlibay opened this issue Jan 3, 2025 · 2 comments · Fixed by #4881

Comments

@IAlibay
Copy link
Member

IAlibay commented Jan 3, 2025

PR #4854 added a water selection keyword but was merged without adding any documentation to the selections docs here: https://github.com/MDAnalysis/mdanalysis/blob/develop/package%2Fdoc%2Fsphinx%2Fsource%2Fdocumentation_pages%2Fselections.rst

This needs to be done so that the keyword is appropriately exposed to users.

@RMeli
Copy link
Member

RMeli commented Jan 3, 2025

@talagayev would you mind please adding such documentation? Thank you!

@talagayev
Copy link
Member

talagayev commented Jan 3, 2025

@IAlibay, @RMeli yes, I can add the documentation and create a PR for it tomorrow.

Should it be like it is for protein, backbone, nucleic, nucleicbackbone currently in the selections.rst, so that it is an entry under Simple selections or should it also have some additional example of usage?

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 a pull request may close this issue.

3 participants