Make it clear which client methods do not make an API call
オープン
初心者向け
enhancement
- 主要言語
- Python
- スター
- 459
- フォーク
- 223
- 平均マージ
- 8時間 57分
- マージ済み PR(30日)
- 13
説明
In both the README and in client.py, it isn't made clear that `Client.folder()`, `Client.file()`, etc. do not make an API call by default (they initialize an empty object, which can then be used to make API calls).
We should call this out, both in the README, and in the docstrings of those methods.
コントリビューションガイド
調査の方向性
Start by reading the client methods in client.py, including Client.folder() and Client.file(), then check the corresponding README usage or API documentation. Update the README and method docstrings so they clearly state that these methods initialize empty objects without making an API call by default; done means both locations communicate this behavior.
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 68/100