Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docstring for lz4.compress_block_bound #117

Merged

Conversation

ods
Copy link
Contributor

@ods ods commented Nov 8, 2023

Right now it's copy-pasted from compress_block_into method:

>>> print(cramjam.lz4.compress_block_bound.__doc__)

Determine the size of a buffer which is guaranteed to hold the result of block compression, will error if
data is too long to be compressed by lz4.

Python Example
--------------
```python
>>> cramjam.lz4.compress_block_into(
...     b'some bytes here',
...     output=output_buffer,
...     mode=Option[str],
...     acceleration=Option[int],
...     compression=Option[int],
...     store_size=Option[bool]
... )
```

Copy link
Owner

@milesgranger milesgranger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super, thank you!

@milesgranger milesgranger merged commit 0bea714 into milesgranger:master Nov 9, 2023
65 checks passed
@ods ods deleted the fix-lz4-compress_block_bound-docstring branch November 9, 2023 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants