Skip to content

Can we ignore single line breaks in docstrings? #29

Description

@kdmccormick

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions