Skip to content

multiple entries in a See Also section #28

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.

Sign up for GitHub

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

Jump to bottom
Closed
ev-br opened this issue Nov 25, 2014 · 2 comments
Closed

multiple entries in a See Also section #28

ev-br opened this issue Nov 25, 2014 · 2 comments

Comments

@ev-br
Copy link
Contributor

ev-br commented Nov 25, 2014

Observed in scipy.interpolate docs

See Also
------------
splev, splrep : FITPACK wrappers

The description text (the stuff after the colon) does not show up in the generated html docs.

Moving the description to a separate line,

See Also
------------
splev, splrep 
             FITPACK wrappers

does not help either
@ev-br ev-br mentioned this issue Nov 25, 2014
Merged
@ev-br
Copy link
Contributor Author

ev-br commented Mar 9, 2015

Apparently, this is a feature, not a bug. At least precisely this behavior is asserted by tests:
https://github.com/numpy/numpydoc/blob/master/numpydoc/tests/test_docscrape.py#L574

FWIW I actually wonder why

@jnothman
Copy link
Member

I don't see where this behaviour is/was tested at https://github.com/numpy/numpydoc/blob/96a0fe3/numpydoc/tests/test_docscrape.py#L574...

@ev-br ev-br mentioned this issue Apr 13, 2018
Merged
@larsoner larsoner mentioned this issue Apr 11, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jnothman @ev-br