Skip to content

docs(requirements): mirror .. versionchanged:: 26.3 into requirements.rst - #1208

Merged
henryiii merged 3 commits into
pypa:mainfrom
r266-tech:docs/requirements-versionchanged-26-3
Jun 8, 2026
Merged

henryiii merged 3 commits into
pypa:mainfrom
r266-tech:docs/requirements-versionchanged-26-3

Conversation

@r266-tech

Copy link
Copy Markdown
Contributor

The Requirement docstring gained a .. versionchanged:: 26.3 note in #1206, but the hand-written docs/requirements.rst reference (which mirrors the docstring's versionchanged blocks — 26.2 is present) wasn't synced. This adds the matching 26.3 block.

@brettcannon
brettcannon requested a review from henryiii June 1, 2026 20:54
@henryiii

henryiii commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Good catch, though I'm not very happy with that comment and now it's in two places. :) This was preserved before 26.2, it's only the dedicated pickle support in 26.2 that broke it. Maybe we should just consider it a bug and drop both? Or add "the dedicated picked support introduced in 26.2 did not preserve this, now it is included" or something like that?

@r266-tech

Copy link
Copy Markdown
Contributor Author

Reworded the note to the regression framing you suggested:

The dedicated pickle support introduced in 26.2 did not preserve the specifier's explicit prereleases override; it is now included again.

Two follow-ups, your call:

  • The docstring (requirements.py, from fix: preserve Requirement specifier prereleases across pickle #1206) still has the old "now preserved across a pickle round trip" wording — happy to sync it to match in this PR so the two stay consistent.
  • Or, if you'd rather treat the 26.2 behavior as a plain bug and not document it at all, I'll close this and send a one-liner dropping the note from the docstring too.

requirements.rst is hand-maintained and already mirrors the docstring's 23.2/26.2 blocks, so I leaned toward keeping the mirror — but either direction is fine with me.

@henryiii

henryiii commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

happy to sync it to match

That sounds good.

@r266-tech

Copy link
Copy Markdown
Contributor Author

Pushed the docstring sync so requirements.py and requirements.rst now use the same regression framing for the 26.3 note. Thanks!

r266-tech added 3 commits June 8, 2026 11:32
…ts.rst

The Requirement docstring gained a `.. versionchanged:: 26.3` note in pypa#1206;
the hand-written docs/requirements.rst reference mirrors these blocks (26.2
present) but was not synced.
@henryiii
henryiii force-pushed the docs/requirements-versionchanged-26-3 branch from 7f41252 to 90e480d Compare June 8, 2026 15:32
@henryiii
henryiii enabled auto-merge (squash) June 8, 2026 15:34
@henryiii
henryiii merged commit bf9e2d3 into pypa:main Jun 8, 2026
59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants