Add assign_clade information to documentation #62
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The goal here is to have one place for user/getting started information. We'll put it in the README so it's viewable from GitHub, and will then pull the README into the sphinx docs.
It's not clear that the Tree object has usefulness outside of the clade assignment process, so removing it from the public-facing docs for now.
Add an example to the assign_clades docstring and document the individual attributes of the Clade object.
Keep the code example on the landing page very simple and put the links to the detailed documentation in a more prominent place.
This changeset also removes an unsed exception
bsweger
force-pushed
the
bsweger/update-docs/59
branch
from
8f5de12
to
cc26fc9
Compare
matthewcornell
approved these changes
Nov 19, 2024
nickreich
approved these changes
Nov 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #59
This PR consolidates the repo's README and the documentation's User Guide into a single piece of text to keep them in sync. It also adds more information about using the
assign_cladesmethod ofCladeTimeand does some other improvements.The changes can be reviewed commit by commit.