mapbox/mapbox-sdk-py

Include numpy-style doctrings for all service methods

Open

#195 aperta il 28 giu 2017

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (111 fork)batch import
documentationgood first issue

Metriche repository

Star
 (319 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Some of our service methods are missing docstrings altogether, others have narrative comments only. We should use numpy-style docstrings throughout to

  • specify Parameters, Return values
  • facilitate API doc generation

Guida contributor

Direzione di ricerca
Guarda i metodi di servizio esistenti e aggiungi docstring in stile numpy seguendo il pattern nel codice.
Tech stack
python
Dominio
documentationbackend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85