litestar-org/litestar

Docs: Code block line length

Open

#3.211 geöffnet am 16. März 2024

Auf GitHub ansehen
 (5 Kommentare) (3 Reaktionen) (1 zugewiesene Person)Python (550 Forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Repository-Metriken

Stars
 (8.243 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 22h) (53 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandene blacken docs Konfiguration im Projekt und passen Sie die Zeilenlänge auf 80 an. Prüfen Sie außerdem manuell die code block Direktiven in der Dokumentation auf übermäßig lange Zeilen und brechen Sie diese entsprechend um.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80