Add "raises <exception type>" to docstrings

Metriche repository

Star

1296 stelle (1296 stelle)

Metriche merge PR

Merge medio 19g 5h (Merge medio 19g 5h)6 PR mergiate in 30 g (6 PR mergiate in 30 g)

Descrizione

Guida contributor

Direzione di ricerca

Esamina i docstring nel codice del client Python, specialmente i metodi che possono sollevare eccezioni. Aggiungi descrizioni `:raises ExceptionType:` seguendo lo stile dei docstring esistenti.

Tech stack

python

Dominio

documentation

Tipo issue

Documentazione

DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.

2

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

GitPython

Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.

75