litestar-org/litestar

Docs: Code block line length

开放

#3,211 创建于 2024年3月16日

在 GitHub 查看贡献者指南
 (5 条评论) (3 个反应) (1 位负责人)Python (550 个派生)user submission
Documentation :books:Good First IssueHelp Wanted :sos:

仓库指标

星标
 (8,243 个星标)
PR 合并指标
 (平均合并 13小时 27分钟) (30 天内合并 26 个 PR)

描述

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

贡献者指南

研究方向
审查项目中现有的 blacken docs 配置，将行长度设置为 80。另外，手动检查文档中代码块指令是否有过长的行，并适当拆分。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
GitSphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80