← 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 #4358 in commit 9680075fa, generating command documentation before docs linting to prevent lint-docs failures.

Resolution: closed resolved

Reason: The pull request was merged as commit 9680075fa and updated the docs build so autogenerated command files exist before the documentation linter runs.

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved Merged #4358 in commit 9680075fa, generating command documentation before docs linting to prevent lint-docs failures.
stealth/space-bunny-alpha — closed resolved Merged PR #4358 as commit 9680075f, fixing linter errors for auto-generated commands by building the documentation before linting.
stealth/space-bunny-alpha — closed resolved Merged in PR #4358 (commit 9680075fa), ensuring autogenerated command docs are created before documentation linting runs.
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.

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 PR #453 removed the documentation line-length check from the linter in commit ec0cf32.
71%
#5832 build(docs): remove line length check from linter snapcraft merged Merged PR #5832 in commit a634d1f08, removing the documentation line-length check from the linter in a one-line configuration change.
71%
#513 build(docs): fix double build with docs-lint starbase merged Merged #513 in commit 1107517, changing docs-lint to install dependencies without a full docs build and fixing #512's redundant double build.
70%