Make it clear which client methods do not make an API call
- Dominant language
- Python
- Stars
- 459
- Forks
- 223
- Avg merge
- 8h 57m
- Merged PRs (30d)
- 13
Description
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.
Contributor guide
Research direction
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.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100