matrix-org / matrix-org/matrix-python-sdk
Add docstrings to all public methods
オープン
まだ誰も着手していません。
Api layer
Client layer
documentation
good first issue
- 主要言語
- Python
- スター
- 266
- フォーク
- 118
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
For instance, get_display_name in api.MatrixHttpApi needs a docstring. Many others as well.
In doing this, you may run across methods that it seems should be private rather than public; in that case, please go ahead and make method call _method while raising a deprecation warning and point all code within the sdk towards _method
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
api.MatrixHttpApi の get_display_name から始め、SDK の他の公開メソッドを洗い出し、それらの既存の呼び出し元を調べます。完了条件は、すべての公開メソッドに docstring があること、非公開と判断されたメソッドが警告付きの非推奨公開ラッパーを介して委譲すること、SDK 内部の呼び出しが非公開名を使用することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- api, documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100