starred/brotli
1
0
Fork 0
mirror of https://github.com/google/brotli.git synced 2026-07-08 17:56:58 +00:00
Code Issues 1.2k Packages Projects Releases 20 Wiki Activity

Is there any python documentation? #330

New Issue
Closed
opened 2026-01-29 20:42:07 +00:00 by claunia · 1 comment
claunia commented 2026-01-29 20:42:07 +00:00
Owner
Copy Link

Originally created by @mlissner on GitHub (Jul 28, 2020).

I've looked around a bit, but aside from install directions, there doesn't seem to be any python documentation. I'd be happy to update the readme with some information. Just a simple...

  • This is how you compress
  • This is how you decompress

...would be helpful.

Is this written down anywhere? Also, is the python API stable? Often when it's not documented, it shouldn't be trusted?

Originally created by @mlissner on GitHub (Jul 28, 2020). I've looked around a bit, but aside from install directions, there doesn't seem to be any python documentation. I'd be happy to update the readme with some information. Just a simple... - This is how you compress - This is how you decompress ...would be helpful. Is this written down anywhere? Also, is the python API stable? Often when it's not documented, it shouldn't be trusted?
claunia added the help wanted label 2026-01-29 20:42:07 +00:00
claunia commented 2026-01-29 20:42:08 +00:00
Author
Owner
Copy Link

@eustas commented on GitHub (Sep 2, 2020):

Tests are the best documentation =) API is stable and hasn't changed since its initial publication.
PRs that improve the textual documentation are welcome.

@eustas commented on GitHub (Sep 2, 2020): Tests are the best documentation =) API is stable and hasn't changed since its initial publication. PRs that improve the textual documentation are welcome.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
feature
help wanted
pull-request
Mirrored from GitHub Pull Request
 release-v1.1
release-v1.1.1
release-v1.2
No Label help wanted
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/brotli#330
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?