Skip to content

Add coordinate type to usage docs #341

@korikuzma

Description

@korikuzma

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)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpriority:lowLow priority

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions