UCL-ARC / UCL-ARC/python-tooling
Enforce a docstring style (or allow users to set)
オープン
まだ誰も着手していません。
documentation
enhancement
p4-low
task
- 主要言語
- Python
- スター
- 62
- フォーク
- 10
- 平均マージ
- 7日 6時間
- マージ済み PR（30日）
- 6
説明
We can enforce this with https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings. Let's make an issue for that.
Originally posted by @paddyroddy in https://github.com/UCL-ARC/python-tooling/pull/566#discussion_r2215495808
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Start with the Ruff FAQ section linked in the issue, then inspect how this Python template configures Ruff and docstrings. Clarify whether the template should enforce one style or expose a user setting, and consider the work done when that behavior is consistently configured for generated projects.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100