Skip to content

'Unknown section' warning should say where it isΒ #10

Closed
@takluyver

Description

@takluyver

One thing I frequently have to fix is people using incorrect section headers, e.g. 'Return' instead of 'Returns'. The warning in this case just looks like this:

Unknown section Return

Most Sphinx warnings do a reasonable job of telling me which file or docstring the problem was in, which makes it much easier to fix.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions