Skip to content

docsic dos not respect paragraph-level markup if a line stars with direcitve #724

@xqt

Description

@xqt

The easiest way to demonstate the issue is the following code which triggers SIG401: param not indented correctly (incorrect-indent)

def foo(bar) -> None:
    """Test SIG401.

    .. note::
       A "SIG401: param not indented correctly (incorrect-indent)" is thrown 
       if a function reference starts on a new line within this note, see
       :func:`baz` <-- this line here.

    :param bar: Just for tests.
    """

Environment:

  • Python version: 3.13
  • docsig version: 0.77.0 and 0.78.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions