falconry/falcon

Docs should demonstrate returning early in a responder

Open

#1.595 aberto em 29 de out. de 2019

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

Métricas do repositório

Stars
 (9.293 stars)
Métricas de merge de PR
 (Mesclagem média 2d 7h) (9 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Identifique as principais seções na documentação do Falcon (por exemplo, roteamento, middleware, tratamento de erros) onde adicionar exemplos de retorno antecipado em respondentes seria mais útil. Procure por padrões existentes e adicione trechos de código simples.
Pilha de tecnologia
python
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitBasic knowledge of Falcon
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90