gh-151945: Fix reference warnings in http.cookiejar and http.server docs#152815
gh-151945: Fix reference warnings in http.cookiejar and http.server docs#152815harjothkhara wants to merge 1 commit into
Conversation
…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>
Documentation build overview
|
|
Please check for people already working on issues, @picnixz is assigned to this. I'm afraid I'm going to close. |
|
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 |
|
Inactually wanted to work on the HTTP server part so they can claim the cookiejar part. |
Fixes the Sphinx nit-picky reference warnings for
Doc/library/http.cookiejar.rstandDoc/library/http.server.rst, andremoves both files from
Doc/tools/.nitignoreso future regressions arecaught by CI.
Approach:
Cookie.version,CookiePolicy.rfc2965/hide_cookie2, theurllib.request.Requestmethods and attributes, andurllib.response.addinfourl.info.get_origin_req_hostmethod, and the undocumentedhttp.servermembersserver_name,server_port,list_directory,guess_typeandindex_pages. I'm happy to document any of these instead if a reviewerprefers.
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-improvedpasses.Documentation-only reference fix, so no
Misc/NEWS.dentry (skip news).Disclosure: I used AI assistance on this change; I've reviewed it and can
explain it.
Doc/library/http.{cookiejar,server}.rst#151945