Skip to content

Fix ZstdDecompressor exception documentation - #154864

Merged
emmatyping merged 1 commit into
python:mainfrom
cuishuang:fix_doc
Aug 14, 2026
Merged

Fix ZstdDecompressor exception documentation#154864
emmatyping merged 1 commit into
python:mainfrom
cuishuang:fix_doc

Conversation

@cuishuang

@cuishuang cuishuang commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

The documentation for compression.zstd.ZstdDecompressor.decompress() stated that calling the method after reaching the end of a frame raises ZstdError.

The implementation raises EOFError, which is also the behavior expected by the tests. Update the documentation to match the actual behavior.

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels Jul 29, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 29, 2026
@read-the-docs-community

read-the-docs-community Bot commented Jul 29, 2026

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33814341 | 📁 Comparing 8a3a307 against main (9ccd5bb)

  🔍 Preview build  

1 file changed
± library/compression.zstd.html

@cuishuang

cuishuang commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

@emmatyping @gpshead @hugovk Hi, Could you please review this PR at your convenience? Thank you very much.

@emmatyping emmatyping added needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 14, 2026
emmatyping
emmatyping approved these changes Aug 14, 2026
View reviewed changes

@emmatyping emmatyping left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks, good catch!

@emmatyping
emmatyping merged commit 1bb7995 into python:main Aug 14, 2026
45 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Aug 14, 2026
@miss-islington-app

miss-islington-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

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

@bedevere-app

bedevere-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

GH-155763 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 14, 2026
@bedevere-app

bedevere-app Bot commented Aug 14, 2026

Copy link
Copy Markdown

GH-155764 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 14, 2026
emmatyping pushed a commit that referenced this pull request Aug 14, 2026
@miss-islington @cuishuang
[3.14] Correct decompression exception in zstd documentation (GH-154864…
58de03c 
…) (#155764)

Correct decompression exception in zstd documentation (GH-154864)
(cherry picked from commit 1bb7995)

Co-authored-by: cui fliter <imcusg@gmail.com>
hugovk pushed a commit that referenced this pull request Aug 14, 2026
@miss-islington @cuishuang
[3.15] Correct decompression exception in zstd documentation (GH-154864…
28c7de6 
…) (#155763)

Correct decompression exception in zstd documentation (GH-154864)
(cherry picked from commit 1bb7995)

Co-authored-by: cui fliter <imcusg@gmail.com>
mbeijen pushed a commit to mbeijen/cpython that referenced this pull request Aug 14, 2026
@cuishuang @mbeijen
Correct decompression exception in zstd documentation (python#154864)
8b1da5e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emmatyping emmatyping emmatyping approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Compression issues 🗜
Status: Done
Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@cuishuang @emmatyping @StanFromIreland