Skip to content

:deco: role is not handling ~ correctly #140220

Closed as not planned
Closed as not planned

Description

@Gobot1234

Documentation

https://docs.python.org/3/library/warnings.html#warnings.deprecated the @~typing.overload part doesn't look right. Might be a sphinx bug?

Activity

  1. StanFromIreland commented on Oct 16, 2025

    @StanFromIreland
    Member

    Yes, this seems like a Sphinx bug. It was introduced in #139619.

    CC @AA-Turner @picnixz

  2. changed the title [-]warnings.deprecated module name not removed properly[/-] [+]`:deco:` role is not handling `~` correctly[/+] on Oct 16, 2025
  3. AA-Turner commented on Oct 16, 2025

    @AA-Turner
    Member

    Sphinx has tests that :deco: works properly with ~, this is odd.

    Ahh, not yet released: sphinx-doc/sphinx#13545

    A

  4. StanFromIreland commented on Oct 16, 2025

    @StanFromIreland
    Member

    What should be done with this issue then?

  5. johnslavik commented on Oct 24, 2025

    @johnslavik
    Member

    What should be done with this issue then?

    I think we could keep this open just so that duplicate issues aren't filed, wait for a new release of Sphinx, bump Sphinx version in Doc/requirements.txt if needed, and then close.

  6. StanFromIreland commented on Dec 2, 2025

    @StanFromIreland
    Member

    We've updated to Sphinx 9, and this has been fixed.

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 dir

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions