DOC: Documentation improvements #11
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
We need to write ``fn() -> pandas.DataFrame`` instead of ``fn() -> pd.DataFrame``.
In README.rst we need to use hard API links so they will be rendered correctly on GitHub, but on readthedocs (or other builds of the documentation) we want them to link to the current build so the class has the same version as is currently being viewed.
Instead of recommending
~/Datasets/bioscan/bioscan-5m/
we now recommend
~/Datasets/bioscan/
This is because the dataset itself contains a bioscan5m directory,
so the full path to the files was
~/Datasets/bioscan/bioscan-5m/bioscan5m/...
The new suggestion avoids the duplicated path.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Improvements to API documentation, and README.