falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1,595 opened on 2019年10月29日

GitHub で見る
 (12 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.