Documentation + some fixes #40
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
|
The only problem here is stupid 79 character limit. ./fn/immutable/heap.py:135:80: E501 line too long (86 > 79 characters) I have a PR to fix this on @artemisart fork / doc branch |
|
LGTM! 👍 |
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.
Hi,
I though it was too bad that there was no documentation for this package, and that it seriously hurts its discoverability so I started creating one.
To preview it, run
make -C docs apidoc htmland then opendocs/build/html/index.html. The documentation will be uploadable to readthedocs.io.I also tried to improve the README + some docstrings and converted existing code blocks to doctests, let me know what you think about it 🙂.