← Back to issue list

docs: force max line length of 80 characters

View original Github issue

Metadata

Project
rockcraft
Number
#175
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

Merged changes enforcing an 80-character maximum line length for documentation using sphinx-lint. Applied minor fixes across 13 files, passed CI, and received approval from three reviewers.

Suggested action:

No scores available.

Issue body

Use the already-enabled sphinx-lint tool to enforce 80 characters max per line, to facilitate review. Also enable *all* sphinx-lint linters, which in this case just mean some minor fixes. Unfortunately we can't use tools like rstfmt because our docs have deviated enough from "standard" rst (using sphinx-only directives) that the tools fail to parse the source. This is a "next best thing" in that sphinx-lint doesn't format the docs, but can at least check it. - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ----- (CRAFT-1503)

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged changes enforcing an 80-character maximum line length for documentation using sphinx-lint. Applied minor fixes across 13 files, passed CI, and received approval from three reviewers.
qwen3.6-35b-a3b-mtp-q6 Merged documentation updates enforcing an 80-character line limit via sphinx-lint. The tool was selected over rstfmt due to Sphinx directive incompatibilities. All linters were enabled to apply minor fixes and streamline review.
qwen3.6-35b-a3b-mtp-q6 Merged. Enforced 80-character max line length for docs using sphinx-lint to streamline reviews and apply minor fixes. rstfmt was skipped due to Sphinx directive incompatibility. Resolves CRAFT-1503.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#5832 build(docs): remove line length check from linter snapcraft merged Merged after approval by two reviewers. Removes the line length check from the documentation linter. All required CI checks passed, with a single line modification applied.
72%
#453 build(docs): remove line length check from linter starbase merged Merged a change removing the line length check from the documentation linter. Approved by two reviewers, passed all CI checks, and updated a single line.
71%