Skip to content

docstring-first-line-empty #7237

@stdedos

Description

@stdedos

Current problem

Hello there! Is there "a real reason" for this problem: docstring-first-line-empty? (https://pylint.pycqa.org/en/latest/user_guide/messages/convention/docstring-first-line-empty.html)

Don't "all tools" just use textwrap.dedent(str).strip() or something along those lines? :/

Desired solution

So, for the purposes of docstring-first-line-empty; can we have "another" stylistic check like docstring-first-line-must-be-empty?
Except for """those""" docstrings, I like the uniformity of """\nThis is going to be a long docstring ...\n"""

Additional context

I'm not sure I like the https://peps.python.org/pep-0257/#handling-docstring-indentation:~:text=The%20docstring%20in%20this%20example%20contains%20two%20newline%20characters%20and%20is%20therefore%203%20lines%20long.%20The%20first%20and%20last%20lines%20are%20blank%3A (i.e. one-liner docstring is actually 3 lines), but I'll let it slide ...

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions