Improve README and add docstrings #21
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
Closed
Cito
force-pushed
the
improve-readme-and-add-docstrings
branch
3 times, most recently
from
113287e to
6a904fe
Compare
Separate between official and internal helper functions. Only the official functions are listed in __all__, and the internal ones are moved to the bottom of the file. Also, added a script to create docs from the docstrings. Add Python 3.6 and 3.7 as supported Python versions.
Cito
force-pushed
the
improve-readme-and-add-docstrings
branch
from
6a904fe to
e7b4b04
Compare
|
About 8 months ago I would have killed to have this version. This PR makes me inordinately happy |
ProjectCheshire
approved these changes
Apr 6, 2019
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.
Separate between official and internal helper functions. Only the official functions are listed in
__all__, and the internal ones are moved to the bottom of the file.Use
json_encodeanddefault_format_erroras default values, so they don't need to be imported any more (and have therefore been excluded from__all__. But everything that is now considered internal is still available for import, nothing is broken.Also, added a script to create docs from the docstrings.