Skip to content
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

See Also: no newline required #25

Open
DerWeh opened this issue Sep 20, 2021 · 1 comment
Open

See Also: no newline required #25

DerWeh opened this issue Sep 20, 2021 · 1 comment

Comments

@DerWeh
Copy link

DerWeh commented Sep 20, 2021

velin wants to put a newline after : in the See Also section.

The style guide,
https://numpydoc.readthedocs.io/en/latest/format.html#see-also
however, recommends a newline only if the line is too long.
Can this behavior of velin be changed, or should an option/configuration be given to ignore this?

@Carreau
Copy link
Owner

Carreau commented Sep 20, 2021

Probably. See also is one of the things I want to change, there is also poor support when there are many items, to correctly wrap when the see also is a list of multiple items.

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

2 participants