PyCQA/pydocstyle

Support a new rule: no blank line after last docstring section

Open

#530 opened on Apr 1, 2021

View on GitHub
 (3 comments) (1 reaction) (0 assignees)Python (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

Repository metrics

Stars
 (1,106 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

D413 says "Missing blank line after last section". It'd be awesome to have the opposite, and raise a new warning when there is a blank line at the end of a docstring. Using Google style, there shouldn't be an empty line at the end, so a warning should exist for this case.

Thank you for your consideration!

Contributor guide

Research direction
Implement a new rule similar to D413 but inverse: check for a blank line after the last section in a docstring with Google style. Study existing rule D413 in pydocstyle source to understand pattern, add new check in the appropriate module, write tests, and update documentation.
Tech stack
python
Domain
developer experiencetoolingtesting qa
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65