-
-
Notifications
You must be signed in to change notification settings - Fork 160
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
Exception/crash when validating doc-string with \
-line-break in summary
#457
Comments
oscargus
changed the title
Exception/crash when checking doc-string with
Exception/crash when checking doc-string with May 18, 2023
\
-line-break in first sentence.\
-line-break in summary
oscargus
changed the title
Exception/crash when checking doc-string with
Exception/crash when validating doc-string with May 18, 2023
\
-line-break in summary\
-line-break in summary
I'm not sure this is a numpydoc problem, at least not on its own. The parsing/conversion to the docstring object seems to handle this case okay: >>> from numpydoc.docscrape_sphinx import SphinxFunctionDoc
>>> def foo():
...: """A really long docstring summary \
...: https://numpydoc.readthedocs.io/en/latest/format.html#short-summary
...:
...: See Also
...: --------
...: bar
...: """
>>> sds = SphinxFunctionDoc(foo) # No exception here
>>> print(sds)
A really long docstring summary https://numpydoc.readthedocs.io/en/latest/format.html#short-summary
.. seealso::
:obj:`bar`
.. It be good to confirm that this problem doesn't originate from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
(Enough to have a single
\
, but for motivation.)Leads to, when checking:
Version: 1.5.0
(I guess the reason I started using
\
is that some other checker, (velin?), allows this.)The text was updated successfully, but these errors were encountered: