Skip to content

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

Description

@yedpodtrzitko

Documentation

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

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:

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. orsenthil commented on Oct 4, 2022

    @orsenthil
    Member

    Could open a pull request to fix this?

  2. yedpodtrzitko commented on Oct 4, 2022

    @yedpodtrzitko
    Author

    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?

  3. davidism commented on Oct 4, 2022

    @davidism

    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. 
  4. added 4 commits that reference this issue on Oct 7, 2022
  5. added 2 commits that reference this issue on Oct 7, 2022
  6. added 4 commits that reference this issue on Oct 8, 2022
  7. added a commit that references this issue on Oct 8, 2022
  8. hauntsaninja commented on Oct 9, 2022

    @hauntsaninja
    Contributor

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

  9. added a commit that references this issue on Oct 9, 2022
  10. added a commit that references this issue on Oct 11, 2022
  11. added a commit that references this issue on Oct 22, 2022
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 direasy

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions