falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1595 aperta il 29 ott 2019

Vedi su GitHub
 (12 commenti) (0 reazioni) (0 assegnatari)Python (925 fork)batch import
documentationgood first issueneeds contributor

Metriche repository

Star
 (9293 star)
Metriche merge PR
 (Merge medio 2g 7h) (9 PR mergiate in 30 g)

Descrizione

New Falcon users may not realize they can simply return anywhere in a responder. This is useful for complicated nested logic paths. We should make sure examples of this are sprinkled throughout the docs in key places.

Guida contributor

Direzione di ricerca
Identifica le sezioni chiave nella documentazione di Falcon (es. routing, middleware, gestione degli errori) in cui aggiungere esempi di return anticipato nei responder sarebbe più utile. Cerca pattern esistenti e aggiungi semplici snippet di codice.
Tech stack
python
Dominio
backend
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
GitBasic knowledge of Falcon
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90