← Back to issue list

style(docs): fix linter errors for auto-generated commands

View original Github issue

Metadata

Project
snapcraft
Number
#4358
Type
pull request
State
merged
Author
mr-cal
Labels
Created
Updated
Closed

Current evaluation

Merged via rebase-and-merge after two approvals and passing CI. Fixed linter errors in auto-generated documentation by ensuring docs are built prior to linting. Modified 5 files with negligible coverage impact.

Suggested action:

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `make lint`? - [x] Have you successfully run `pytest tests/unit`? ----- Autogenerated documentation needs to be created before running the linters. You should be able to reproduce this problem on `main`: ``` tox run -e build-docs tox run -e lint-docs # fails on autogenerated commands ``` 2 separate commits so this is a rebase-and-merge.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged via rebase-and-merge after two approvals and passing CI. Fixed linter errors in auto-generated documentation by ensuring docs are built prior to linting. Modified 5 files with negligible coverage impact.
qwen3.6-35b-a3b-mtp-q6 Merged a fix for linter errors in auto-generated documentation by ensuring docs are built before linting. Applied via rebase-and-merge with two commits.
qwen3.6-35b-a3b-mtp-q6 Merged via rebase-and-merge. Fixed linter errors in auto-generated documentation by ensuring docs are built before running linters, resolving lint-docs failures on main.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
75%
#513 build(docs): fix double build with docs-lint starbase merged Merged a one-line fix resolving a double build issue during docs-lint by correcting a mistaken assumption about Sphinx's linter requirements. Approved by two reviewers, passed CI, and closed issue #512.
75%
#144 docs: include auto-generated code docs craft-store merged Merged to include auto-generated code documentation, resolving issue #127. Approved by two reviewers, passed CI checks, and modified three files with nine added lines.
75%
#551 docs: resolve `docs-lint` issues starbase merged Merged after resolving documentation linting issues. Excluded docs/_dev/ from Sphinx linting and updated link checker timeout. Passed all CI checks, received approval, and was successfully integrated.
74%
#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.
74%
#1302 docs: rewrite some redirects craft-parts merged Merged documentation rewrite correcting several redirects to resolve recurring lint CI failures. Approved by two reviewers, passed all CI checks, and modified four files with minimal changes.
74%
#529 docs: minor clean up and reorg starbase merged Merged after two approvals. Docs were reorganized by moving docs/how-to-guides to docs/how-to, fixing indentation, adding default descriptions, and resolving ruff linting in conf.py. Changes touch 8 files.
73%
#2466 build(docs): remove line length check from linter charmcraft merged Merged a one-line change removing the line length check from the documentation linter. Approved by two reviewers. Accepted after passing primary CI checks, despite initial failures on macOS and Ubuntu 20.04.
73%
#2222 style: fix linting issues charmcraft merged Merged following approval by two reviewers. Resolved linting issues across three files with minor style adjustments (+8/-9 lines). No review comments or CI checks were required.
73%
#5 style(lint): fix linting issues starflow merged Merged after approval. Resolved linting issues by modifying one file with three additions and three deletions. No unresolved comments or CI checks were present.
73%