Skip to content

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

Closed
@takluyver

Description

@takluyver
Contributor

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.

Activity

marscher

marscher commented on Nov 19, 2014

@marscher

this applies to all sections. There is no useful information given, where to find this. Of course one can grep the location, but why now directly providing it?

jnothman

jnothman commented on Sep 17, 2017

@jnothman
Member

Fixed in #101

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @jnothman@marscher@takluyver

        Issue actions

          'Unknown section' warning should say where it is · Issue #10 · numpy/numpydoc