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 (1,106 stars) (191 forks)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

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

Tech stack
python
Domain
documentationtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonbasic understanding of pydocstyle rules
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
First, read the contributing guidelines and the existing rule implementation for D413 (likely in src/pydocstyle/checker.py). Understand how rules are defined and registered. Then implement a new rule that checks for a blank line after the last section in a Google style docstring. Add tests and documentation. The issue is clear but no maintainer response yet; consider asking for clarification on the expected behavior for edge cases.