[CI] Linting of docs
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- ci-cd, documentation, tooling
調査の方向性
Review the repository's CI configuration and supported Python versions first, then compare ruff and pydocstyle against the Python 3.6 compatibility constraint and the proposed Python 3.7+ environment. Done means documentation and docstrings are linted in CI without breaking supported environments, addressing the class of issue described in #716.
索引モデルが issue の本文から書いたものです。
説明
Currently there is no linter for doc and docstrings.
As a follow up, this should really be linted. I would advocate using ruff but theoretically that's blocked on still supporting python 3.6 (#1083).
Should work if working in an environment that's 3.7+ though.
The alternative is to use pydocstyle.
This would prevent issues like #716 from appearing. (which I guess can be closed now?)
- 主要言語
- Python
- スター
- 361
- フォーク
- 296
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openml/openml-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
openml/openml-python#1749 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
openml/openml-python#1746 ·
-
Documentation Good First Issue
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
openml/openml-python#1708 · コメント 6 件 ·
-
Good First Issue module:Run testing
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openml/openml-python#1646 · コメント 7 件 · リアクション 2 件 ·
-
Good First Issue module:Data testing
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openml/openml-python#1644 · コメント 4 件 ·
openml/openml-python の issue をすべて見る
似ている issue
-
essnmx good first issue
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
-
[Feature] 奇物选择添加优先级 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
syfoud/Simulated_Scepter#174 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Giskard-AI/giskard-oss#2840 · コメント 1 件 ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success オープンarea: repo bug perceived difficulty: 2
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
yeti-platform/yeti#1380 ·