Docstrings for public APIs in `meridian.runtime`

オープン
#124 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

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

調査の方向性

Read CONTRIBUTING.md, then inspect the public classes, methods, and functions under src/meridian/runtime/ and use nearby docstrings as examples. Run uv run ruff check src/meridian/runtime --select D101,D102,D103 to find missing docstrings; add a one-line description for each. Done when that command reports no issues.

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

説明

area: runtime documentation good first issue size: S
Context

ruff's pydocstyle rules find about 48 public classes, methods and functions in src/meridian/runtime/ with no docstring.

What to do

Add one-line docstrings saying what each does (the surrounding code has good examples).

Done when

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

Where to look

src/meridian/runtime/


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


Generated by Claude Code

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

環境構築

はじめの一歩

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

patsypppe/meridian のほかの issue

patsypppe/meridian の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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