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

Can we ignore single line breaks in docstrings? #29

Open
kdmccormick opened this issue Apr 30, 2020 · 0 comments
Open

Can we ignore single line breaks in docstrings? #29

kdmccormick opened this issue Apr 30, 2020 · 0 comments

Comments

@kdmccormick
Copy link
Member

It's common hard-wrap docstrings to abide by max-line-length conventions:

class MyView(...):    
    def get(...):
        """
        Do a thing.

        This is my long and very helpful description of what my endpoint is for
        which I am manually breaking into two lines.
        """

which yields:

This is my long and very helpful description of what my endpoint is for
which I am manually breaking into two lines.

It'd be nice to instead see the soft-wrapped version in the output:

This is my long and very helpful description of what my endpoint is for which I am manually breaking into two lines.

Of course, double-line breaks should still be regarded as actual line breaks in the output.

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

1 participant