Skip to content

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

Closed
harjothkhara wants to merge 1 commit into
python:mainfrom
harjothkhara:gh-151945-http-doc-refs
Closed

gh-151945: Fix reference warnings in http.cookiejar and http.server docs#152815
harjothkhara wants to merge 1 commit into
python:mainfrom
harjothkhara:gh-151945-http-doc-refs

Conversation

@harjothkhara

Copy link
Copy Markdown
Contributor

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

Approach:

  • 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.
  • References with no documented target become inline literals: the removed
    get_origin_req_host method, and the undocumented http.server members
    server_name, server_port, list_directory, guess_type and
    index_pages. I'm happy to document any of these instead if a reviewer
    prefers.

Verified with a full nit-picky docs build: both files now emit zero
warnings, and Doc/tools/check-warnings.py --fail-if-regression --fail-if-improved passes.

Documentation-only reference fix, so no Misc/NEWS.d entry (skip news).

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

…http.server docs

Resolve the nit-picky reference warnings in Doc/library/http.cookiejar.rst
and Doc/library/http.server.rst, and drop both files 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 that have
no documented target become inline literals: the removed
get_origin_req_host method, and the undocumented http.server members
server_name, server_port, list_directory, guess_type and index_pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #33398163 | 📁 Comparing 901c4f1 against main (df2538a)

  🔍 Preview build  

2 files changed
± library/http.cookiejar.html
± library/http.server.html

@StanFromIreland

Copy link
Copy Markdown
Member

Please check for people already working on issues, @picnixz is assigned to this. I'm afraid I'm going to close.

@harjothkhara

Copy link
Copy Markdown
Contributor Author

Sorry about that. I saw the assignment but noticed other assigned sub-issues here have open community PRs (like #151961 on #151943), so I wasn't sure it was a hard claim. Happy to defer to @picnixz.

The patch is done and verified: both files build clean in nit-picky mode and check-warnings.py --fail-if-regression --fail-if-improved passes. So if @picnixz hasn't started, it's ready to review. If they have, I'll close this. I'm also glad to take an unassigned sub-issue instead, like Doc/whatsnew/ in #151942 which has no PR yet.

@picnixz

picnixz commented Jul 1, 2026

Copy link
Copy Markdown
Member

Inactually wanted to work on the HTTP server part so they can claim the cookiejar part.

@harjothkhara

Copy link
Copy Markdown
Contributor Author

Thanks @picnixz — opened #152816 for the http.cookiejar half. http.server is all yours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants