falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1 595 ouverte le 29 oct. 2019

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)Python (925 forks)batch import
documentationgood first issueneeds contributor

Métriques du dépôt

Stars
 (9 293 stars)
Métriques de merge PR
 (Merge moyen 2j 7h) (9 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Identifiez les sections clés de la documentation Falcon (par exemple, le routage, le middleware, la gestion des erreurs) où l'ajout d'exemples de retour anticipé dans les répondeurs serait le plus utile. Recherchez les modèles existants et ajoutez des extraits de code simples.
Stack technique
python
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitBasic knowledge of Falcon
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90