GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | |||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | |||||||||||||||||||
GeezerVison is showing github.com — gh-132983: Add documentation for compression.zstd by emmatyping · Pull Request #133911 · python/cpython Conversation
|
|
cc @python/proofreaders, I think the text here could benefit from a close reading, Stan has already noted several English grammar/syntax points. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Are there any active members, out of curiosity? I do not know of any nor have seen any around.
I will go through it again later. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
🙋 I at least look at all pings to the group. Will usually weigh in if I have time, and as long as no one else has beaten me to what I'd have to say. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Co-authored-by: Stan Ulbrych <[email protected]>
I use one for items within a class, two for at the module level, but that's probably too complicated and I should probably just choose two lines. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There are, but we don't get explicitly called on very often, it seems... |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
- Rewrite the digested/undigested dict section - Add a section for exceptions - wrap lines to ~80 chars - clarify that an exception is raised if level is passed to a decompressor - make quotes in docs for open vs ZstdFile consistent - Remove currently and repeated "note"
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Looking pretty good now.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I wasn't absolutely thorough in reviewing all the proposed text, but have a few suggestions for clarification. Thanks for the work.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]>
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Co-authored-by: Martin Panter <[email protected]>
- improve argument descriptions - improve clarity about the meaning of parameter value 0s - clarify behavior of compress/flush - many more clarifications/wording improvements
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Besides some nitpicks, LGTM.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
| decompression, passing a digested dictionary will reduce the overhead of | ||
| loading the dictionary. | ||
|
|
||
| .. list-table:: Difference for compression |
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I think that simple nested item lists would look better here. Maybe not even nested item lists, just an item lists with two or three paragraphs in every item.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I'm not sure I understand what you have in mind, perhaps it can be resolved in a follow-up?
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
- Use "integer" instead of "int object" - Use > 0 rather than >=1 for nb_workers
|
Thanks @emmatyping for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
) Add documentation for compression & compression.zstd. 🎉 --------- (cherry picked from commit d862b6d) Co-authored-by: Emma Smith <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
|
GH-134425 is a backport of this pull request to the 3.14 branch. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
…134425) gh-132983: Add documentation for compression.zstd (GH-133911) Add documentation for compression & compression.zstd. 🎉 --------- (cherry picked from commit d862b6d) Co-authored-by: Emma Smith <[email protected]> Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
) Add documentation for compression & compression.zstd. 🎉 --------- Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
) Add documentation for compression & compression.zstd. 🎉 --------- Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
) Add documentation for compression & compression.zstd. 🎉 --------- Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
) Add documentation for compression & compression.zstd. 🎉 --------- Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Stan Ulbrych <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]> Co-authored-by: Martin Panter <[email protected]>
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
There was an error while loading. Please reload this page.