PyCQA/pydocstyle

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

Open

#530 创建于 2021年4月1日

在 GitHub 查看
 (3 评论) (1 反应) (0 负责人)Python (1,106 star) (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

描述

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!

贡献者指南

技术栈
python
领域
documentationtooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Pythonbasic understanding of pydocstyle rules
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
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.