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

倉庫指標

Star

1,106 star (1,106 star)

PR 合併指標

30 天內沒有已合併 PR (30 天內沒有已合併 PR)

描述

貢獻者指南

研究方向

研究 pydocstyle 目前如何處理配置選項，例如查看 'config.py' 檔案以及現有標誌如 ' add ignore' 或 ' match'。理解 'pydocstyle/checker.py' 中的驗證邏輯，查看公共/私有區分的執行位置。該功能請求要求新增一個標誌以包含私有方法；一個良好的實作可能是新增一個 CLI 選項和相應的配置欄位，然後修改驗證迴圈，以便在標誌設定時也檢查私有成員。

技術棧

python

領域

documentation

議題類型

功能

難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。

2

預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。

1-3 小時

活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。

活躍

清晰度議題是否清楚說明預期改動、驗收標準和下一步。

清晰

前置要求

PythonGit

新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。

75