box / box/box-python-sdk

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

Aperta Adatta ai principianti
#196 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Python
Stelle
459
Fork
223
Merge medio
8h 57m
PR unite (30g)
13

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo i metodi del client in client.py, inclusi Client.folder() e Client.file(), quindi controlla l’utilizzo corrispondente in README o la documentazione dell’API. Aggiorna README e i docstring dei metodi in modo che dichiarino chiaramente che questi metodi inizializzano oggetti vuoti senza effettuare una chiamata API per impostazione predefinita; il lavoro è completato quando entrambe le posizioni comunicano questo comportamento.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.