falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1,595 opened on Oct 29, 2019

View on GitHub
 (12 comments) (0 reactions) (0 assignees)Python (925 forks)batch import
documentationgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (Avg merge 2d 7h) (9 merged PRs in 30d)

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.

Contributor guide

Research direction
Identify key sections in the Falcon documentation (e.g., routing, middleware, error handling) where examples of early return in responders would be most helpful. Look for existing patterns and add simple code snippets.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic knowledge of Falcon
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90