litestar-org/litestar

Docs: Code block line length

Open

#3 211 ouverte le 16 mars 2024

Voir sur GitHub
 (5 commentaires) (3 réactions) (1 assigné)Python (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Métriques du dépôt

Stars
 (8 243 stars)
Métriques de merge PR
 (Merge moyen 2j 22h) (53 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez la configuration existante de blacken docs dans le projet et ajustez la longueur de ligne à 80. De plus, vérifiez manuellement les directives code block dans la documentation pour les lignes trop longues et coupez les de manière appropriée.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80