GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-151945: Fix reference warnings in http.cookiejar and http.server docs by harjothkhara · Pull Request #152815 · python/cpython

Conversation

@harjothkhara

@harjothkhara harjothkhara commented Jul 1, 2026

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.

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@harjothkhara @claude
pythongh-151945: Fix Sphinx reference warnings in http.cookiejar and …
901c4f1
…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 <[email protected]>
@harjothkhara
harjothkhara requested review from AA-Turner, StanFromIreland and hugovk as code owners July 1, 2026 17:51
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jul 1, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Jul 1, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jul 1, 2026
@bedevere-app 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 bedevere-app Bot added the awaiting review label Jul 1, 2026
@read-the-docs-community

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

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@StanFromIreland

StanFromIreland commented Jul 1, 2026

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@StanFromIreland StanFromIreland closed this Jul 1, 2026
@harjothkhara

harjothkhara commented Jul 1, 2026

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.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@harjothkhara

harjothkhara commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

Reviewers

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner
@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner
@StanFromIreland StanFromIreland Awaiting requested review from StanFromIreland StanFromIreland is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@harjothkhara @StanFromIreland @picnixz
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.