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.