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 — Update annotation parameters for objects in documentation · Issue #129667 · python/cpython

Update annotation parameters for objects in documentation #129667

New issue
Copy link
New issue
Copy link
Open
Open
Update annotation parameters for objects in documentation#129667
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc dir

Description

@donbarbos
donbarbos
opened on Feb 4, 2025
Issue body actions

Working on PR #129607 noticed that one parameter was missing in http.server.HTTPServer documentation, so I decided to send a separate PR to update the documentation and at the same time check some more entities in the stdlib.

And I started to finding a lot of such cases and wanted to automate it. Then I found out that sphinx already has something similar to do automatically now I offer you this as an idea. Maybe it is possible to include such a feature in sphinx or write your own script so that it checks this in CI (for example using inspect and rst parser).

It seems very important to me that the documentation is accurate in such things and doesn't become outdated

I don't think it's a good practice for contributors to change parameters in the documentation themselves (or forget about it :-).
At least we could report discrepancies between documentation and annotations from code.

I'll send PR with what I've already found.

Linked PRs

  • gh-129667: Update annotation in documentation #129669

Activity

  1. donbarbos
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Feb 4, 2025
  2. github-project-automation
    added this to docs issueson Feb 4, 2025
  3. github-project-automation
    moved this to Todo in docs issueson Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirDocumentation in the Doc dir

    Projects

    • docs issues
      Status
      Todo
      Show more project fields

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    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.