falconry/falcon

Consider moving all the tutorial code to files, having not only the final version there

Open

#2.247 aberto em 13 de jul. de 2024

Ver no GitHub
 (8 comments) (0 reactions) (0 assignees)Python (925 forks)batch import
documentationgood first issuemaintenance

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

At the moment only the final version of the tutorials is in the example folder, while the intermediate code is pasted into the rst files.

It would be nice to have all versions in code, so that lint and format tool etc could work on those too.

We could probably use examples/asgilook/versions/01_file.py, examples/asgilook/versions/02_file.py etc

Guia do colaborador

Direção de pesquisa
Examine a pasta atual 'examples/asgilook/' e os arquivos de tutorial RST. Proponha um esquema de nomenclatura para arquivos versionados (ex.: '01 file.py', '02 file.py') e mova o código intermediário dos arquivos RST para esses novos arquivos. Atualize os arquivos RST para incluir o código dos novos arquivos em vez de trechos inline. Garanta que ferramentas de lint e formatação possam ser aplicadas a todos os arquivos versionados.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Refatoraçã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.
1-3 horas
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
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80