Skip to content

docstring-first-line-empty / C0199 "Problematic code" documentation sample is unclear #10337

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

Closed
andrei-korshikov opened this issue Apr 10, 2025 · 2 comments · Fixed by #10354
Closed
Assignees
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation

Comments

@andrei-korshikov
Copy link

Current "Problematic code" sample:

def foo():  # [docstring-first-line-empty]
    """

    Lorem Ipsum is simply dummy text of the printing and typesetting
    industry.

    Lorem Ipsum has been the industry's standard dummy text ever since the
    1500s, when an unknown printer took a galley of type and scrambled it
    to make a type specimen book
    """

Suggested "Problematic code" sample (just remove the second empty line):

def foo():  # [docstring-first-line-empty]
    """
    Lorem Ipsum is simply dummy text of the printing and typesetting
    industry.

    Lorem Ipsum has been the industry's standard dummy text ever since the
    1500s, when an unknown printer took a galley of type and scrambled it
    to make a type specimen book
    """

From the current sample, it is not clear which empty line triggers the error—the very first (""") or the next.

@zenlyj zenlyj added Good first issue Friendly and approachable by new contributors Documentation 📗 Needs PR This issue is accepted, sufficiently specified and now needs an implementation Help wanted 🙏 Outside help would be appreciated, good for new contributors and removed Good first issue Friendly and approachable by new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation labels Apr 11, 2025
@ranadheerg
Copy link
Contributor

I would like to work on this issue. Please assign this to me

@Pierre-Sassoulas
Copy link
Member

Done, thank you @ranadheerg !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📗 Good first issue Friendly and approachable by new contributors Help wanted 🙏 Outside help would be appreciated, good for new contributors Needs PR This issue is accepted, sufficiently specified and now needs an implementation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants