DOI-USGS / DOI-USGS/dataretrieval-python

wqp.py documentation improvements

Aperta
#163 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
265
Fork
63
Merge medio
1g 20h
PR unite (30g)
19

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo wqp.py e consultando la documentazione collegata di Swagger e del webservice per individuare dove manca contesto ai nuovi utenti. Documenta lo scopo delle funzioni e cosa gli utenti dovrebbero aspettarsi da quei collegamenti, evitando kwargs specifici del servizio e instabili; il lavoro è completato quando le funzioni sono più chiare senza richiedere aggiornamenti frequenti.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.