falconry/falcon

Docs should demonstrate returning early in a responder

Offen

#1.595 geöffnet am 29.10.2019

Auf GitHub ansehenContributor Guide
 (12 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (925 Forks)batch import
documentationgood first issueneeds contributor

Repository-Metriken

Stars
 (9.293 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 7h) (9 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Identifiziere die wichtigsten Abschnitte in der Falcon Dokumentation (z.B. Routing, Middleware, Fehlerbehandlung), in denen Beispiele für frühes Zurückgeben in Respondern am hilfreichsten wären. Suche nach bestehenden Mustern und füge einfache Codeausschnitte hinzu.
Tech Stack
python
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitBasic knowledge of Falcon
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90