box / box/box-python-sdk

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

Abierto Apto para principiantes
#196 0 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
459
Forks
223
Merge medio
8 h 57 min
PR fusionados (30 d)
13

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza leyendo los métodos del cliente en client.py, incluidos Client.folder() y Client.file(), y luego revisa el uso correspondiente en README o la documentación de la API. Actualiza README y los docstrings de los métodos para que indiquen claramente que estos métodos inicializan objetos vacíos sin realizar una llamada a la API de forma predeterminada; se considera terminado cuando ambas ubicaciones comunican este comportamiento.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
68/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.