litestar-org/litestar

Docs: Code block line length

Open

#3,211 opened on Mar 16, 2024

View on GitHub
 (5 comments) (3 reactions) (1 assignee)Python (8,243 stars) (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

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

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonblacken docs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Look for the blacken docs configuration in the repository's pyproject.toml file. Set the line length option to 80. Verify that the change only applies to documentation code blocks by checking the configuration scope. Also, examine existing docs for any code blocks that already exceed 80 characters and may need manual adjustment.