Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
takluyver opened this issue Jan 29, 2014 · 2 comments
Closed

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

takluyver opened this issue Jan 29, 2014 · 2 comments

Comments

@takluyver
Copy link
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.

@marscher
Copy link

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
Copy link
Member

Fixed in #101

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants