◐ Shell
reader mode source ↗
Skip to content

gh-132983: Fix docstrings in ZstdDict#137321

Merged
AA-Turner merged 5 commits into
python:mainfrom
Rogdham:zstddict_fix_docstrings
Aug 3, 2025
Merged

gh-132983: Fix docstrings in ZstdDict#137321
AA-Turner merged 5 commits into
python:mainfrom
Rogdham:zstddict_fix_docstrings

Conversation

@Rogdham

@Rogdham Rogdham commented Aug 2, 2025 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

Fixes in docstrings:

  1. Remove extra " at the end of ZstdDict.as_prefix
  2. Fix dictionary,without being all glued together in ZstdDict.dict_id
  3. Add line returns to respect line length in ZstdDict.dict_id

Diff of help(ZstdDict) for illustration:
image

@bedevere-app bedevere-app Bot mentioned this pull request Aug 2, 2025
Closed
13 tasks
@Rogdham Rogdham marked this pull request as draft August 2, 2025 09:28
@Rogdham

Rogdham commented Aug 2, 2025

Copy link
Copy Markdown
Contributor Author

Sorry for the noise on this PR, I was having difficulties with clinic, but it should be ok now.

On an unrelated note, should this be backported to 3.14?

@Rogdham Rogdham marked this pull request as ready for review August 2, 2025 09:55
@picnixz picnixz added the needs backport to 3.14 bugs and security fixes label Aug 2, 2025
@picnixz

picnixz commented Aug 2, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Yeah, 3.14 is still in an RC1 phase and Zstd has been added for 3.14. So updating the docs etc should be part of 3.14. It doesn't make sense to wait for 3.15 to become the stable version before noticing those bugs.

emmatyping
emmatyping approved these changes Aug 2, 2025
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.

Hide comment

Thank you for spotting these!

AA-Turner
AA-Turner approved these changes Aug 3, 2025
View reviewed changes

@AA-Turner AA-Turner left a comment •
edited
Loading

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.

Hide comment

@Rogdham for the future, you can use the "apply suggestion" button (or batched changes via the "files" tab), which can often be quicker, and has the benefit of automatically resolving the review comments.

A

@AA-Turner AA-Turner enabled auto-merge (squash) August 3, 2025 14:45
Hide details View details @AA-Turner AA-Turner merged commit 676748d into python:main Aug 3, 2025
40 checks passed
@miss-islington-app

miss-islington-app Bot commented Aug 3, 2025

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the label Aug 3, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 3, 2025
@Rogdham @AA-Turner @miss-islington
pythongh-132983: Fix docstrings in ZstdDict (pythonGH-137321) …
6b906a9 
(cherry picked from commit 676748d)

Co-authored-by: Rogdham <3994389+Rogdham@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Aug 3, 2025

Copy link
Copy Markdown

GH-137343 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 3, 2025
@Rogdham Rogdham deleted the zstddict_fix_docstrings branch August 3, 2025 15:10
hugovk pushed a commit that referenced this pull request Aug 3, 2025
@miss-islington @Rogdham @AA-Turner
[3.14] gh-132983: Fix docstrings in ZstdDict (GH-137321) (#137343) …
833d883 
Co-authored-by: Rogdham <3994389+Rogdham@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@Rogdham @AA-Turner @Agent-Hellboy
pythongh-132983: Fix docstrings in ZstdDict (python#137321) …
bff2573 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington @Rogdham
@AA-Turner @kumaraditya303
[3.14] pythongh-132983: Fix docstrings in ZstdDict (pythonGH-137321… …
f626b50 
…) (python#137343)

Co-authored-by: Rogdham <3994389+Rogdham@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aisk aisk aisk approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@AA-Turner AA-Turner AA-Turner approved these changes

@emmatyping emmatyping emmatyping approved these changes

@picnixz picnixz picnixz approved these changes

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Rogdham @picnixz @aisk @serhiy-storchaka @AA-Turner @emmatyping @StanFromIreland