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 — documentation for `http.server` refers to wrong `test()` function · Issue #97822 · python/cpython

documentation for http.server refers to wrong test() function #97822

New issue
Copy link
New issue
Copy link
Closed
Closed
documentation for http.server refers to wrong test() function#97822
Copy link
Labels
docsDocumentation in the Doc dirDocumentation in the Doc direasy

Description

@yedpodtrzitko
yedpodtrzitko
opened on Oct 4, 2022
Issue body actions

Documentation

the following paragraph in docs for http.server mentions function test:

cpython/Doc/library/http.server.rst

Lines 395 to 396 in e3b6ff1

For example usage, see the implementation of the :func:`test` function
invocation in the :mod:`http.server` module.

which is a reference to function test in the same file:

cpython/Lib/http/server.py

Line 1239 in 9a95fa9

def test(HandlerClass=BaseHTTPRequestHandler,

but in the rendered docs :func:`test` is resolved as a link to https://docs.python.org/3/library/test.html#module-test instead of the aforementioned function in the same file.

Activity

  1. yedpodtrzitko
    added
    docsDocumentation in the Doc dirDocumentation in the Doc dir
    on Oct 4, 2022
  2. orsenthil commented on Oct 4, 2022

    @orsenthil
    orsenthil
    on Oct 4, 2022
    Member
    More actions

    Could open a pull request to fix this?

  3. orsenthil
    added
    easy
    on Oct 4, 2022
  4. yedpodtrzitko commented on Oct 4, 2022

    @yedpodtrzitko
    yedpodtrzitko
    on Oct 4, 2022
    Author
    More actions

    sure, I just dont know what's the recommended way how to refer to a specific function in the code - do I use link with the latest commit or is it preferred some other way?

  5. davidism commented on Oct 4, 2022

    @davidism
    davidism
    on Oct 4, 2022
    More actions

    List the full path to the name, it will be a link with the text http.server.test:

    For example, see the implementation of the :func:`http.server.test` function.

    Alternatively, add a ~ at the front, and it will remain in the current format, showing only the test name.

    For example, see the implementation of the :func:`~http.server.test` function in the :mod:`http.server` module. 
    Reacted by yed
  6. Jason-Y-Z
    added 4 commits that reference this issue on Oct 7, 2022

    pythongh-97822: Fix http.server documentation reference to test() fun…

    0355123

    pythongh-97822: Fix http.server documentation reference to test() fun…

    9d4a36b

    pythongh-97822: Fix http.server documentation reference to test() fun…

    d57649f

    pythongh-97822: Fix http.server documentation reference to test() fun…

    0682fbd
  7. JelleZijlstra
    added 2 commits that reference this issue on Oct 7, 2022

    Merge branch 'main' into pythongh-97822

    97790bf

    gh-97822: Fix http.server documentation reference to test() function (#…

    6b48562
  8. miss-islington
    added 4 commits that reference this issue on Oct 8, 2022

    pythongh-97822: Fix http.server documentation reference to test() fun…

    1676696

    pythongh-97822: Fix http.server documentation reference to test() fun…

    5442004

    gh-97822: Fix http.server documentation reference to test() function (G…

    b5196fa

    gh-97822: Fix http.server documentation reference to test() function (G…

    786fde5
  9. carljm
    added a commit that references this issue on Oct 8, 2022

    Merge branch 'main' into typewatch

    d67d6fd
  10. hauntsaninja commented on Oct 9, 2022

    @hauntsaninja
    hauntsaninja
    on Oct 9, 2022
    Contributor
    More actions

    Looks like this is fixed and all backports are merged. Thank you!

  11. hauntsaninja
    closed this as completedon Oct 9, 2022
  12. carljm
    added a commit that references this issue on Oct 9, 2022

    Merge branch 'main' into urllibnonet

    132c32e
  13. mpage
    added a commit that references this issue on Oct 11, 2022

    pythongh-97822: Fix http.server documentation reference to test() fun…

    e20a190
  14. pablogsal
    added a commit that references this issue on Oct 22, 2022

    gh-97822: Fix http.server documentation reference to test() function (G…

    dfae46c
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 direasy

    Projects

    No projects

      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.