litestar-org/litestar

Docs: Code block line length

Open

#3.211 aberto em 16 de mar. de 2024

Ver no GitHub
 (5 comments) (3 reactions) (1 assignee)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métricas do repositório

Stars
 (8.243 stars)
Métricas de merge de PR
 (Mesclagem média 2d 22h) (53 fundiu PRs em 30d)

Description

Summary

For documentation, and only documentation, if you have an overly long code block it enters scrollable window.

We should set blacken-docs configuration (and eventually ruff when https://github.com/astral-sh/ruff/issues/8237 happens) to line lengths somewhere on the lower end (maybe 80?); this goes together with manually ensuring .. code-block:: directives are not overly long

Guia do colaborador

Direção de pesquisa
Revise a configuração existente do blacken docs no projeto e ajuste o comprimento da linha para 80. Além disso, verifique manualmente as diretivas code block na documentação para linhas muito longas e quebre as adequadamente.
Pilha de tecnologia
python
Domain
documentation
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
GitSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80