Add missing API docs to Sphinx #214
Merged
Conversation
This file contains hidden or 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
eric-czech
reviewed
Aug 27, 2020
| * If ploidy of provided dataset != 2 | ||
| * If maximum number of alleles in provided dataset != 2 | ||
| If ploidy of provided dataset != 2 | ||
| NotImplementedError |
There was a problem hiding this comment.
I had originally been breaking multiple causes of the same error out like this but @ravwojdyla suggested collapsing them in a past PR. @ravwojdyla did you have a reason for that?
There was a problem hiding this comment.
Sphinx doesn't render the bullets correctly, which is why I changed this.
eric-czech
approved these changes
Aug 27, 2020
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.
We need to make sure we add new functions to
docs/api.rst. Perhaps a note in the contributor guide?This fixes the build, but some of the formatting is not quite right. We should also visually check the docs whenever we add new functions to check that links, formatting etc are OK.
Fixes #212