rust-lang/rust-clippy

Rust API Guideline: Function docs include error conditions in "Errors" section

Open

#1790 aperta il 27 mag 2017

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)Rust (1391 fork)batch import
A-lintL-guidelinesT-middlegood first issue

Metriche repository

Star
 (10.406 star)
Metriche merge PR
 (Merge medio 19g 22h) (113 PR mergiate in 30 g)

Descrizione

As per Function docs include error, panic, and safety considerations.

Guida contributor

Direzione di ricerca
Consulta le linee guida dell'API Rust per documentare le condizioni di errore. Trova le funzioni di lint di Clippy che mancano di una sezione 'Errors' nei commenti di documentazione e aggiungila.
Tech stack
rust
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
GitRust
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85