DOI-USGS / DOI-USGS/dataretrieval-python
wqp.py documentation improvements
- Lenguaje dominante
- Python
- Estrellas
- 266
- Forks
- 63
- Merge medio
- 1 d 20 h
- PR fusionados (30 d)
- 19
Descripción
As noted by @jzemmels, a new dataretrieval-python user might find the swagger docs and webservice documentation a little tough to get the hang of. Ideally, we'd have the `kwargs` specified for each function within the function documentation, but it's tricky when the service arguments may not be stable over time. This increases developer burden to update documentation in the repository. However, there might be a compromise where we provide a little better descriptors of the functions and what the user might expect to learn from the webservice links/swagger docs.
Guía de contribución
Línea de trabajo
Empieza leyendo wqp.py y revisando la documentación enlazada de Swagger y del webservice para identificar dónde les falta contexto a los usuarios nuevos. Documenta el propósito de las funciones y qué deberían esperar los usuarios de esos enlaces, evitando kwargs específicos del servicio que sean inestables; se considera terminado cuando las funciones sean más claras sin requerir actualizaciones frecuentes.
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
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100