Cleanup readme and docstrings
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まずリポジトリのREADMEとPythonのdocstringを確認し、次にSphinxまたは別のドキュメント生成ツールが設定されているか確認します。どの反復的な型の説明を変更すべきか、またどのようなドキュメント出力が期待されるかを明確にします。合意したREADMEとdocstringで、冗長な型の記述なしに引数が説明されれば作業は完了です。
索引モデルが issue の本文から書いたものです。
説明
IMO, it's pretty silly having these docstrings just repeat the type of the argument. Rather, they should describe the argument and then whatever document generation tool we use will automatically insert the type annotations (i.e. Sphinx). Just mentioning it now though. We can deal with it later.
- 主要言語
- Python
- スター
- 35
- フォーク
- 27
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apertium/apertium-python のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 32/100
apertium/apertium-python#109 · コメント 2 件 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
apertium/apertium-python#108 · コメント 10 件 · リアクション 1 件 ·
-
segfaultオープン
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
apertium/apertium-python#106 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
apertium/apertium-python#105 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
apertium/apertium-python#102 · コメント 3 件 ·
apertium/apertium-python の issue をすべて見る
似ている issue
-
jobs restart --verify: hotlane restart timeout (10s) shorter than its shutdown (~30s) → false exit 1オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
EtanHey/brainlayer#1072 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
_apply_doc_content: a cancel during the shielded image gather still sends the content batchUpdateオープンenhancement
難易度 2/5 1時間未満 初心者へのやさしさ 80/100
khuisman/mcp-gee-sweet#904 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
-
CORE-HIST-005/006 multi-turn history tests send three different messages with the same messageIdオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
a2aproject/a2a-tck#248 ·