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

Add coordinate type to usage docs #341

Open
korikuzma opened this issue Jul 31, 2024 · 0 comments
Open

Add coordinate type to usage docs #341

korikuzma opened this issue Jul 31, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation priority:low Low priority

Comments

@korikuzma
Copy link
Member

I think this language could be slightly clearer. What I meant to say in my previous comment was that in the abstract, residue- and inter-residue coordinates can both be 0- or 1-indexed. I think what we're saying here is that the RESIDUE enum value means "1-indexed residue" and INTER_RESIDUE means "0-indexed inter-residue". Feel free to edit further but I think we should have this line say something like

``RESIDUE`` means 1-indexed, residue coordinates and ``INTER_RESIDUE`` means 0-indexed, inter-residue coordinates.

I also think we should probably have a note about this in the "usage" section of the docs -- feel free to make a new issue + assign me if you agree

Originally posted by @jsstevenson in #337 (comment)

@korikuzma korikuzma added documentation Improvements or additions to documentation priority:low Low priority labels Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:low Low priority
Projects
None yet
Development

No branches or pull requests

2 participants