PyCQA/pydocstyle

Have a flag or config option to also include private methods/classes/etc in the verifications

Open

#516 建立於 2020年10月22日

在 GitHub 查看
 (0 留言) (3 反應) (0 負責人)Python (1,106 star) (191 fork)batch import
Minor (New Feature)Waiting for Assigneegood first issuehelp wanted

描述

This way all methods/classes/etc will be verified, not only public ones.

貢獻者指南

技術棧
python
領域
toolingdeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of pydocstyle configuration
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
Investigate how pydocstyle currently handles configuration options, e.g., by looking at the 'config.py' file and existing flags like ' add ignore' or ' match'. Understand the verification logic in 'pydocstyle/checker.py' to see where public/private distinction is enforced. The feature request asks for a flag to include private methods; a good implementation might add a CLI option and corresponding configuration field, then modify the verification loop to also check private members when the flag is set.