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

harjothkhara · 2026-07-01T18:12:51Z

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>

read-the-docs-community · 2026-07-01T18:17:11Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #33413357 | 📁 Comparing 097e9ce against main (df2538a)

🔍 Preview build

5 files changed · ± 5 modified

± Modified

hugovk

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":

hugovk · 2026-07-02T05:46:04Z

+    attribute. Dependency on a deprecated method ``get_origin_req_host`` has
+    been removed.


To keep same formatting:

Suggested change

attribute. Dependency on a deprecated method ``get_origin_req_host`` has

been removed.

attribute. Dependency on a deprecated method

:meth:`!get_origin_req_host` has been removed.

hugovk · 2026-07-02T05:46:33Z

+    attribute. Dependency on a deprecated method ``get_origin_req_host`` has
+    been removed.


Suggested change

attribute. Dependency on a deprecated method ``get_origin_req_host`` has

been removed.

attribute. Dependency on a deprecated method

:meth:`!get_origin_req_host` has been removed.

hugovk · 2026-07-02T05:48:29Z

+turn it off again by
 setting it to :const:`None`.


https://devguide.python.org/documentation/markup/#quick-reference

Suggested change

turn it off again by

setting it to :const:`None`.

turn it off again by setting it to ``None``.

And we can update the others in this file as well.

hugovk · 2026-07-02T05:49:43Z

   Add correct :mailheader:`Cookie` header to *request*.

-   If policy allows (ie. the :attr:`rfc2965` and :attr:`hide_cookie2` attributes of
+   If policy allows (ie. the :attr:`~CookiePolicy.rfc2965` and


Let's also avoid Latin abbreviations, and you can update the other ie. and eg. in this file: https://devguide.python.org/documentation/style-guide/#use-simple-language

Suggested change

If policy allows (ie. the :attr:`~CookiePolicy.rfc2965` and

If policy allows (that is, the :attr:`~CookiePolicy.rfc2965` and

StanFromIreland

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>

harjothkhara · 2026-07-02T15:04:32Z

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

hugovk

Thanks!

StanFromIreland

Spotted two little things.

StanFromIreland · 2026-07-02T18:21:30Z

   *filename* is the name of file in which to save cookies.  If *filename* is not
-   specified, :attr:`self.filename` is used (whose default is the value passed to
-   the constructor, if any); if :attr:`self.filename` is :const:`None`,
+   specified, :attr:`~FileCookieJar.filename` is used (whose default is the


Let's keep it as self.filename here, otherwise it renders confusingly as "filename."

StanFromIreland · 2026-07-02T18:23:33Z

-   :meth:`urllib.request.urlopen`, or similar) should support an :meth:`info`
-   method, which returns an :class:`email.message.Message` instance.
+   :meth:`urllib.request.urlopen`, or similar) should support an
+   :meth:`~urllib.response.addinfourl.info` method, which returns an


This method is deprecated, this should link to http.client.HTTPResponse.

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

Open

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

hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, 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

		attribute. Dependency on a deprecated method ``get_origin_req_host`` has
		been removed.

	turn it off again by
	setting it to :const:`None`.
	turn it off again by setting it to ``None``.

	If policy allows (ie. the :attr:`~CookiePolicy.rfc2965` and
	If policy allows (that is, the :attr:`~CookiePolicy.rfc2965` and

Uh oh!

Uh oh!

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!

hugovk Jul 2, 2026

Choose a reason for hiding this comment

Uh oh!

hugovk Jul 2, 2026

Choose a reason for hiding this comment

Uh oh!

hugovk Jul 2, 2026

Choose a reason for hiding this comment

Uh oh!

hugovk Jul 2, 2026

Choose a reason for hiding this comment

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!

StanFromIreland Jul 2, 2026

Choose a reason for hiding this comment

Uh oh!

StanFromIreland Jul 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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

edited

Loading