Docstrings for `grading` and `manifest`

オープン 初心者向け
#126 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
85/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

まず src/meridian/grading/ と src/meridian/manifest/ の公開項目を読み、次に issue に記載された Ruff コマンドを実行して不足している docstring を特定します。報告された項目に docstring を追加し、そのコマンドを再実行します。D101、D102、D103 の違反が報告されなくなれば完了です。

索引モデルが issue の本文から書いたものです。

説明

area: grading documentation good first issue size: S
Context

About 30 public items in src/meridian/grading/ and src/meridian/manifest/ have no docstring.

What to do

Add them.

Done when

uv run ruff check src/meridian/grading src/meridian/manifest --select D101,D102,D103 is clean.

Where to look

src/meridian/grading/, src/meridian/manifest/


New here? Read CONTRIBUTING.md and comment on this issue to say you are taking it.


Generated by Claude Code

主要言語
Python
スター
0
フォーク
0
平均マージ
2時間 13分
マージ済み PR(30日)
19

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

patsypppe/meridian のほかの issue

patsypppe/meridian の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。