astral-sh/ruff

Improve discoverability of the `pydocstyle` rules as per the selected convention

クローズ

#15,217 opened on 2025/01/02

GitHub で見るコントリビューターガイド
 (1 件のコメント) (3 件のリアクション) (0 人の担当者)Rust (2,088 件のフォーク)batch import
documentationhelp wanted

Repository metrics

Stars
 (47,527 個のスター)
PR merge metrics
 (平均マージ 3d 8h) (30d で 573 merged PRs)

説明

If a user has D in the rule selection, the rules that are actually selected depends on the docstring convention that's chosen. Currently, this information only lives at the bottom of this FAQ section: https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. It would be useful to have this visible in an obvious place for which I see two options:

  1. ruff.lint.pydocstyle.convention section
  2. For each of the Dxxx rule page, specify how setting the lint.pydocstyle.convention may affect the selection of this rule

I think I'd prefer option (1) as the documentation is in a single place instead of distributed across multiple rule pages.

コントリビューターガイド

調査方針
Look at the current documentation in the FAQ section (docs.astral.sh/ruff/faq) and the settings page for `lint.pydocstyle.convention` (docs.astral.sh/ruff/settings/#lint pydocstyle convention). The issue suggests adding a list of rules affected by each convention to the settings page, so examine that page's structure. Also consider the rule page templates for `Dxxx` rules to see if they include relevant cross references. The main goal is to decide between two options and implement the chosen one.
技術スタック
pythonrust
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic understanding of Ruff's pydocstyle rulesFamiliarity with Ruff documentation structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85