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 (550 forks)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

Repository metrics

Stars
 (8,243 stars)
PR merge metrics
 (Avg merge 13h 27m) (26 merged PRs in 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

Contributor guide

Research direction
Review the existing blacken docs configuration in the project and adjust the line length setting to 80. Additionally, manually check code block directives in documentation for overly long lines and break them appropriately.
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.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80