Make it clear which client methods do not make an API call

未關閉 適合新手
#196 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
68/100
Issue 類型
文件
描述清晰度
描述清楚
活躍度
停滯
技術堆疊
python
領域
documentation

研究方向

先閱讀 client.py 中的用戶端方法,包括 Client.folder() 和 Client.file(),接著檢查 README 中對應的使用方式或 API 文件。更新 README 和方法 docstring,清楚說明這些方法預設會初始化空物件而不會進行 API 呼叫;當兩個位置都傳達此行為時,即表示完成。

由索引模型根據 Issue 內容生成。

描述

enhancement

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.

主要語言
Python
星號
460
分支
223
平均合併
14 小時 18 分鐘
30 天內合併 PR
21

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

box/box-python-sdk 的其他 Issue

查看 box/box-python-sdk 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。