Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-132983: Add documentation for compression.zstd#133911

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
gpshead merged 23 commits intopython:mainfromemmatyping:zstd-docs
May 21, 2025

Conversation

emmatyping
Copy link
Member

@emmatypingemmatyping commentedMay 12, 2025•
edited by hugovk
Loading

@emmatypingemmatyping added the needs backport to 3.14bugs and security fixes labelMay 12, 2025
Copy link
Member

@AA-TurnerAA-Turner left a comment

Choose a reason for hiding this comment

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

syntactic review

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Copy link
Contributor

@StanFromIrelandStanFromIreland left a comment

Choose a reason for hiding this comment

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

Some grammar notes.

Code block directives need a line after.

Please settle on gaps between descriptions for the file, currently it seems random, some parts use two and others one.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@AA-Turner
Copy link
Member

cc @python/proofreaders, I think the text here could benefit from a close reading, Stan has already noted several English grammar/syntax points.

@StanFromIreland
Copy link
Contributor

@python/proofreaders

Are there any active members, out of curiosity? I do not know of any nor have seen any around.

I think the text here could benefit from a close reading

I will go through it again later.

@bskinn
Copy link
Contributor

@python/proofreaders

Are there any active members, out of curiosity? I do not know of any nor have seen any around.

🙋

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.

AA-Turner, StanFromIreland, emmatyping, and hugovk reacted with thumbs up emoji

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@emmatyping
Copy link
MemberAuthor

@StanFromIreland

Please settle on gaps between descriptions for the file, currently it seems random, some parts use two and others one.

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.

StanFromIreland reacted with thumbs up emoji

@mwichmann
Copy link

@python/proofreaders

Are there any active members, out of curiosity? I do not know of any nor have seen any around.

There are, but we don't get explicitly called on very often, it seems...

emmatypingand others added3 commitsMay 13, 2025 18:40
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
- 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"
Copy link
Contributor

@StanFromIrelandStanFromIreland left a comment

Choose a reason for hiding this comment

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

Looking pretty good now.

Copy link
Contributor

@brainwanebrainwane left a comment

Choose a reason for 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.

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>
emmatypingand others added5 commitsMay 20, 2025 12:01
Co-authored-by: Martin Panter <vadmium@users.noreply.github.com>
- improve argument descriptions- improve clarity about the meaning of parameter value 0s- clarify behavior of compress/flush- many more clarifications/wording improvements
Copy link
Member

@serhiy-storchakaserhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Besides some nitpicks, LGTM.

StanFromIreland reacted with hooray emoji
decompression, passing a digested dictionary will reduce the overhead of
loading the dictionary.

..list-table::Difference for compression

Choose a reason for 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.

Copy link
MemberAuthor

@emmatypingemmatypingMay 21, 2025•
edited
Loading

Choose a reason for 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?

gpshead reacted with thumbs up emoji
- Use "integer" instead of "int object"- Use > 0 rather than >=1 for nb_workers
@gpsheadgpshead moved this fromTodo toDone inDocs PRsMay 21, 2025
@gpsheadgpshead merged commitd862b6d intopython:mainMay 21, 2025
24 checks passed
@miss-islington-app
Copy link

Thanks@emmatyping for the PR, and@gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 21, 2025
)Add documentation for compression & compression.zstd.🎉---------(cherry picked from commitd862b6d)Co-authored-by: Emma Smith <emma@emmatyping.dev>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>Co-authored-by: Martin Panter <vadmium@users.noreply.github.com>
@bedevere-app
Copy link

GH-134425 is a backport of this pull request to the3.14 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.14bugs and security fixes labelMay 21, 2025
gpshead pushed a commit that referenced this pull requestMay 21, 2025
…134425)gh-132983: Add documentation for compression.zstd (GH-133911)Add documentation for compression & compression.zstd.🎉---------(cherry picked from commitd862b6d)Co-authored-by: Emma Smith <emma@emmatyping.dev>Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>Co-authored-by: Sumana Harihareswara <sh@changeset.nyc>Co-authored-by: Martin Panter <vadmium@users.noreply.github.com>
@emmatypingemmatyping deleted the zstd-docs branchMay 21, 2025 14:52
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@brainwanebrainwanebrainwane left review comments

@vadmiumvadmiumvadmium left review comments

@mwichmannmwichmannmwichmann left review comments

@AA-TurnerAA-TurnerAA-Turner left review comments

@StanFromIrelandStanFromIrelandStanFromIreland left review comments

@gpsheadgpsheadgpshead approved these changes

@hugovkhugovkhugovk approved these changes

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip news
Projects
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

10 participants
@emmatyping@AA-Turner@StanFromIreland@bskinn@mwichmann@gpshead@brainwane@vadmium@hugovk@serhiy-storchaka
[8]ページ先頭
©2009-2025 Movatter.jp