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

Open Beginner friendly
#196 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

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.

Dominant language
Python
Stars
460
Forks
223
Avg merge
14h 18m
Merged PRs (30d)
21

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from box/box-python-sdk

All issues in box/box-python-sdk

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.