litestar-org/litestar

Docs: Code block line length

Aperta

#3211 aperta il 16 mar 2024

Vedi su GitHubGuida contributor
 (5 commenti) (3 reazioni) (1 assegnatario)Python (550 fork)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Metriche repository

Star
 (8243 stelle)
Metriche merge PR
 (Merge medio 13h 27m) (26 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la configurazione esistente di blacken docs nel progetto e imposta la lunghezza della riga a 80. Inoltre, controlla manualmente le direttive code block nella documentazione per righe eccessivamente lunghe e spezzale opportunamente.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80