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

Nessuno ha ancora preso questa issue.

Valutazione

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

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.

Descrizione

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.

Lingua principale
Python
Stelle
460
Fork
223
Merge medio
14h 18m
PR unite (30g)
21

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di box/box-python-sdk

Tutte le issue di box/box-python-sdk

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.