falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1,595 创建于 2019年10月29日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)Python (9,293 star) (925 fork)batch import
documentationgood first issueneeds contributor

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python programmingFalcon framework basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
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.