Add docstrings for compress/decompress. #34
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
|
@nkemnitz Do you mind doing a quick sanity check of the documentation that this PR is adding? Thanks! |
|
@william-silversmith mind being a second set of eyes to review this documentation I'm adding? |
pyzfp.pyx
Outdated
| The rate of the compressed data. | ||
| This will use ZFP in fixed-rate mode. | ||
| One of tolerance, precision, or rate must be specified. | ||
| parallel : bool, optional |
There was a problem hiding this comment.
Should note the default is True. I've found that Cython doesn't let you see the function sig so the documentation has to be manually added (or you can add a pure python wrapper around the cython call).
There was a problem hiding this comment.
Did a quick test with help(pyzfp.compress) and it seemed to work fine.
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.
Also raise error for parallel decompress.
Fixes #26