gh-151945: Fix reference warnings in http.cookiejar docs by harjothkhara · Pull Request #152816 · python/cpython · GitHub

Per @picnixz's suggestion in gh-151945, this covers the http.cookiejar
half of the issue; @picnixz is taking http.server.

Fixes the Sphinx nit-picky reference warnings for
Doc/library/http.cookiejar.rst and removes the file from
Doc/tools/.nitignore so future regressions are caught by CI.

Documented targets are qualified with their owning class, e.g.
Cookie.version, CookiePolicy.rfc2965/hide_cookie2, the
urllib.request.Request methods and attributes, and
urllib.response.addinfourl.info.
The removed get_origin_req_host method, which has no documented
target, becomes an inline literal.

Verified with a full nit-picky build: the file emits no warnings and
Doc/tools/check-warnings.py --fail-if-regression --fail-if-improved
passes. Documentation-only reference fix, so no NEWS entry (skip news).

Disclosure: I used AI assistance on this change; I've reviewed it and can
explain it.

Issue: Fix all Sphinx reference warnings in Doc/library/http.{cookiejar,server}.rst #151945

Resolve the nit-picky reference warnings in Doc/library/http.cookiejar.rst and drop the file from Doc/tools/.nitignore so future regressions are caught by CI. Documented targets are qualified with their owning class, for example Cookie.version, CookiePolicy.rfc2965, the urllib.request.Request methods and attributes, and urllib.response.addinfourl.info. References with no documented target become inline literals: the removed get_origin_req_host method. The http.server part of the issue is left for a separate change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Documentation build overview

📚 cpython-previews | 🛠️ Build #33439808 | 📁 Comparing be519e2 against main (df2538a)

🔍 Preview build

7 files changed · ± 7 modified

± Modified

Thanks! Whilst we're here, please could also update the headers to use sentence case?

https://devguide.python.org/documentation/style-guide/#capitalization

That is, change the four "Objects" to "objects":

The reference fixes here are correct 👍 Please apply Hugo's suggestions.

…ge, markup Apply Hugo's review feedback for Doc/library/http.cookiejar.rst: - Use sentence case for the four "... Objects" section headers. - Replace the Latin abbreviations "ie."/"eg." with "that is"/"for example" per the devguide simple-language guidance. - Use ``None`` literal markup instead of :const:`None`. - Reference the removed method as :meth:`!get_origin_req_host` to match the surrounding formatting. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Thank you both! Applied all of Hugo's suggestions. Please re-review when you get a chance.

Thanks!

Spotted two little things.

…self.filename Apply Stan's review feedback: - Point the response info() reference at http.client.HTTPResponse rather than the deprecated urllib.response.addinfourl.info. - Keep the FileCookieJar.save attribute references as self.filename so they read clearly, using :attr:`!self.filename` to avoid a broken cross-reference. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Per Stan's suggestion, use the explicit-title cross-reference :attr:`self.filename <FileCookieJar.filename>` so the text still reads "self.filename" while linking to the documented attribute. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

One little nit but otherwise LGTM, this is a solid improvement of the page. Thanks @harjothkhara and @claude.

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

Merged, thanks.

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

Sorry, @harjothkhara and @StanFromIreland, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 66c76fa6737d497cd3c735f75e67a5ca52eceb15 3.13

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

GH-153034 is a backport of this pull request to the 3.13 branch.

… the `http.cookiejar` docs (GH-152816) (#153033) (cherry picked from commit 66c76fa) Co-authored-by: Harjoth Khara <harjoth.khara@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Stan Ulbrych <stan@python.org>

… the `http.cookiejar` docs (GH-152816) (#153032) (cherry picked from commit 66c76fa) Co-authored-by: Harjoth Khara <harjoth.khara@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Stan Ulbrych <stan@python.org>

… the `http.cookiejar` docs (GH-152816) (#153034) (cherry picked from commit 66c76fa) Co-authored-by: Harjoth Khara <harjoth.khara@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

harjothkhara requested review from AA-Turner, StanFromIreland and hugovk as code owners July 1, 2026 18:12

bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 1, 2026

bedevere-app Bot mentioned this pull request Jul 1, 2026

Fix all Sphinx reference warnings in Doc/library/http.{cookiejar,server}.rst #151945

Closed

bedevere-app Bot added the awaiting review label Jul 1, 2026

github-project-automation Bot added this to Docs PRs Jul 1, 2026

github-project-automation Bot moved this to Todo in Docs PRs Jul 1, 2026

harjothkhara mentioned this pull request Jul 1, 2026

gh-151945: Fix reference warnings in http.cookiejar and http.server docs #152815

Closed

hugovk reviewed Jul 2, 2026

View reviewed changes

Comment thread Doc/library/http.cookiejar.rst Outdated

Comment thread Doc/library/http.cookiejar.rst Outdated

Comment thread Doc/library/http.cookiejar.rst Outdated

Comment thread Doc/library/http.cookiejar.rst Outdated

hugovk added needs backport to 3.13 only security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 bugs and security fixes labels Jul 2, 2026

StanFromIreland reviewed Jul 2, 2026

View reviewed changes

harjothkhara force-pushed the gh-151945-cookiejar-refs branch from 3945666 to 097e9ce Compare July 2, 2026 14:59

hugovk approved these changes Jul 2, 2026

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels Jul 2, 2026

StanFromIreland reviewed Jul 2, 2026

View reviewed changes

Comment thread Doc/library/http.cookiejar.rst Outdated

Comment thread Doc/library/http.cookiejar.rst Outdated

StanFromIreland reviewed Jul 3, 2026

View reviewed changes

Comment thread Doc/library/http.cookiejar.rst Outdated

StanFromIreland approved these changes Jul 4, 2026

View reviewed changes

Comment thread Doc/library/http.cookiejar.rst Outdated

Update Doc/library/http.cookiejar.rst

be519e2

StanFromIreland merged commit 66c76fa into python:main Jul 4, 2026
30 checks passed

github-project-automation Bot moved this from Todo to Done in Docs PRs Jul 4, 2026

bedevere-app Bot removed the awaiting merge label Jul 4, 2026

bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Jul 4, 2026

miss-islington-app Bot assigned StanFromIreland Jul 4, 2026

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Jul 4, 2026

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Jul 4, 2026

gh-151945: Fix reference warnings in http.cookiejar docs by harjothkhara · Pull Request #152816 · python/cpython · GitHub

Repository navigation

gh-151945: Fix reference warnings in http.cookiejar docs - #152816

gh-151945: Fix reference warnings in http.cookiejar docs#152816StanFromIreland merged 5 commits intopython:mainpython/cpython:mainfrom harjothkhara:gh-151945-cookiejar-refsharjothkhara/cpython:gh-151945-cookiejar-refsCopy head branch name to clipboard

Conversation

harjothkhara commented Jul 1, 2026

Uh oh!

read-the-docs-community Bot commented Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

harjothkhara commented Jul 2, 2026

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StanFromIreland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

miss-islington-app Bot commented Jul 4, 2026

Uh oh!

StanFromIreland commented Jul 4, 2026

Uh oh!

bedevere-app Bot commented Jul 4, 2026

Uh oh!

miss-islington-app Bot commented Jul 4, 2026

Uh oh!

bedevere-app Bot commented Jul 4, 2026

Uh oh!

bedevere-app Bot commented Jul 4, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gh-151945: Fix reference warnings in http.cookiejar docs#152816
StanFromIreland merged 5 commits into
python:mainfrom
harjothkhara:gh-151945-cookiejar-refs

read-the-docs-community Bot commented Jul 1, 2026 •
edited
Loading