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 (9,293 stars) (925 forks)batch import
documentationgood first issueneeds contributor

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

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingFalcon framework basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue requests adding examples of early return in responders throughout Falcon's documentation. A contributor should locate the existing documentation for responders (likely in docs/ directory) and identify places where nested logic or early returns could be demonstrated. The PR should add small code snippets showing `return` statements within responder methods, following the existing documentation style. Maintainers have discussed the need in comments, so reviewing the issue thread may provide further guidance.