Add docstring linting (D-class rules) to ruff configuration
まだ誰も着手していません。
評価
調査の方向性
Ruff の設定は pyproject.toml:60 にあります。まず、無視されている D クラスと既存の lint 設定を確認します。現在の D ルール違反を測定し、続いて選択したルールとファイルごとの例外を定義します。合意した D ルールが、未解決のレガシー違反なしに有効化されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Description
The project currently ignores all docstring linting rules (D-class) in the ruff configuration with a TODO comment.
Location
pyproject.toml:60
[tool.ruff.lint]
# The D (doc) and DTZ (datetime zone) lint classes current heavily violated - fix later
select = ["ALL"]
ignore = [
"D", # todo: docstring linting
# ...
]
Impact
- Inconsistent or missing docstrings across the codebase
- Reduced code maintainability and readability
- Harder for new contributors to understand code functionality
Suggested Implementation
- Start by enabling specific D-rules that are least violated (e.g., D100, D101 for missing docstrings)
- Gradually fix existing violations or use per-file ignores for legacy code
- Eventually enable all D-rules for new code
Related
Similar TODO exists for DTZ (datetime zone) rules which should also be addressed.
- 主要言語
- Python
- スター
- 17
- フォーク
- 50
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openml/server-api のほかの issue
-
behavior
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
openml/server-api#337 · コメント 1 件 ·
-
Redesign POST /data/untag for v2再び着手できるかも @omosola が 39 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンproposal
openml/server-api#375 · コメント 2 件 · 担当者 1 名 ·
-
Redesign POST /data/tag for v2再び着手できるかも @omosola が 39 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
openml/server-api#374 · コメント 2 件 · 担当者 1 名 ·
-
Redesign POST /data/qualities/unprocessed/{data_engine_id}/{order} for v2再び着手できるかも @omosola が 39 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
openml/server-api#373 · 担当者 1 名 ·
-
Redesign POST /data/qualities for v2再び着手できるかも @omosola が 39 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
openml/server-api#372 · 担当者 1 名 ·
openml/server-api の issue をすべて見る
似ている issue
-
Performance: deprecated DeviceEntry.config_entries access blocks the event loop for tens of secondsオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
tuya/tuya_cloud_ha_bridge#14 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
semantica-agi/semantica#1968 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
agent: ready area: submission priority: high type: docs
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
dkritarth/scopewatch#213 ·
メンテナーはふだん 1 日以内に返信
-
Broken link in RELEASE.md対応中かも @Jah-yee が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
sphinx-contrib/httpdomain#143 ·
メンテナーはふだん 1 日以内に返信