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

wrap long :param and :return lines #58

Closed
tekumara opened this issue Jul 21, 2020 · 2 comments · Fixed by #201
Closed

wrap long :param and :return lines #58

tekumara opened this issue Jul 21, 2020 · 2 comments · Fixed by #201
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: enhancement Feature that is outside the scope of PEP 257
Milestone

Comments

@tekumara
Copy link

docstring lines beginning with :param or :return aren't wrapped by default

@giff-h
Copy link

giff-h commented Aug 29, 2021

This is annoying, especially since the entire docstring is not processed if there is a :param line that goes long

@weibullguy weibullguy added the P: enhancement Feature that is outside the scope of PEP 257 label Jul 24, 2022
@weibullguy
Copy link
Member

This is another example of docformatter not handling Sphinx directives. See also #78.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: style Relates to docstring format style (e.g., Google, NumPy, Sphinx) P: enhancement Feature that is outside the scope of PEP 257
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants