Improve API documentation #118
Merged
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
grst
force-pushed
the
doc/improve-apidoc
branch
from
2fd9c71
to
4347c3c
Compare
For autodoc docstrings to be linkable, they must be listed in the APIdoc somewhere, therefore, they should be public functions. Therefore, I had to refactor the code base to make some functions public (that arguably should have been public already). Now, there is a public "styling" module under plotting and the `_utils` module is now public as `scirpy.util`.
grst
added a commit
that referenced
this pull request
Aug 23, 2020
Improve API documentation Former-commit-id: d91386ce4071ece9c3662ea4d4ddf687630458ff
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.
One step towards #40