litestar-org/litestar

Docs: Code block line length

Open

#3,211 建立於 2024年3月16日

在 GitHub 查看
 (5 留言) (3 反應) (1 負責人)Python (8,243 star) (550 fork)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

描述

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

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Pythonblacken docs
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.