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

shared-bindings/zlib: Fix docs for zlib.decompress. #8125

Merged
merged 1 commit into from
Jun 28, 2023

Conversation

jimmo
Copy link

@jimmo jimmo commented Jun 27, 2023

Noticed this while working on the zlib module in MicroPython. FYI we're working on adding compression support -- see micropython#11879 -- and was looking to see if CircuitPython implemented this already.

The docs say the method is called zlib_decompress but should be just decompress. (See https://docs.circuitpython.org/en/latest/shared-bindings/zlib/index.html )

dhalbert
dhalbert previously approved these changes Jun 27, 2023
Copy link
Collaborator

@dhalbert dhalbert left a comment

Choose a reason for hiding this comment

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

Whoops - thanks!

@jepler
Copy link
Member

jepler commented Jun 27, 2023

@jimmo pre-commit wants an indentation change. I tried to do it for you (since it says 'maintainers are allowed to edit this pull request') but github didn't permit my push to a branch in your repo.

The docs say the method is called `zlib_decompress` but should be
just `decompress`.

Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
@jimmo
Copy link
Author

jimmo commented Jun 27, 2023

@jimmo pre-commit wants an indentation change. I tried to do it for you (since it says 'maintainers are allowed to edit this pull request') but github didn't permit my push to a branch in your repo.

No worries, updated!

Copy link
Member

@jepler jepler left a comment

Choose a reason for hiding this comment

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

thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants