Use sphinx rst format in all docstrings #18
Merged
+499
−270
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
ItsDrike
added
a: documentation
ItsDrike
force-pushed
the
sphinx-format-docstrings
branch
from
f9de505 to
074cb78
Compare
ItsDrike
force-pushed
the
sphinx-format-docstrings
branch
from
074cb78 to
a3b01da
Compare
ItsDrike
force-pushed
the
sphinx-format-docstrings
branch
from
a3b01da to
6e2be0d
Compare
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.
This converts all docstrings in the library to use sphinx style, getting the codebase ready for auto-generated docs, that pick these docstrings up.
On top of just conversion to a different format, this does also make some general improvements to the wording in some places, and perhaps even adds new docstrings for undocumented things.
tests/, even though these won't be in docs, we want consistencyThis PR is a part of #19.