← Back to issue list

style: fix docstring line breaks

View original Github issue

Metadata

Project
craft-platforms
Number
#167
Type
pull request
State
merged
Author
steinbro
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #167 as commit 97a9041, correcting a docstring line break that caused the documentation CI task to fail; all reported checks passed.

Resolution: closed resolved

Reason: PR canonical/craft-platforms#167 was merged as commit 97a9041 and fixed the malformed docstring line break. The reported documentation failure was corrected, with no pending or failing CI checks.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [ ] Have you followed the guidelines for contributing? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? --- A line break in a docstring was causing the docs task to fail in CI (https://github.com/canonical/craft-platforms/actions/runs/17474601595/job/49631158084). I'm not sure why this wasn't caught in CI for #153.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #167 as commit 97a9041, correcting a docstring line break that caused the documentation CI task to fail; all reported checks passed.
qwen/qwen3.6-35b-a3b — closed resolved Merged to fix a docstring line break that was causing the CI documentation task to fail.

Update history

Date Change
created

Related work

  • Caused By: canonical/craft-platforms#153 (confidence 85%)

    The PR description identifies #153 as the change after which the docstring break had not been caught by CI.

Related issues

Issue Project State Summary Similarity
#6091 fix: extra comma in linters doc snapcraft merged Merged PR #6091 as commit f663411d4, removing an extra comma from the linters documentation.
74%
#992 docs: fix typo craft-application merged PR #992 (commit 71490ecd, "docs: fix typo") merged to main: a one-line documentation typo correction (+1/-1,1 file). Approved by 2 reviewers; all CI green except slow tests on ubuntu-24.04/py3.12.
74%
#1063 docs: fix a missing link rockcraft merged Merged PR #1063 fixed a missing documentation hyperlink in commit 8c4ab4a3; the one-line change was approved by four reviewers.
74%
#4043 doc: fix docstring for accuracy snapcraft merged Merged PR #4043 corrected a one-line docstring inaccuracy, recorded in commit 4d9739580.
74%
#399 docs: fix title markup craft-parts merged Merged #399 as commit 8b705ede, correcting a one-line documentation title markup issue after two approvals.
74%
#114 fix: docs inline code block was misplaced rockcraft merged Merged PR #114 corrected a misplaced inline code block in the documentation via a one-line typo fix, landing in commit bbfd9b28.
73%
#1030 docs: fix some URL issues in docs and CLI messages rockcraft merged Merged PR #1030 as commit f22480ec, correcting URLs in 11 documentation and CLI-message files (+28/-25); all CI checks passed.
73%
#250 docs: fix markup rockcraft merged Merged in 4c458b4f, fixing four approved documentation markup issues across six files; remaining lint fixes were deferred to a follow-up PR.
73%
#1146 test: fix doc version tests craft-application merged Merged PR #1146 as commit 949d2dfe, correcting documentation-version test failures accidentally introduced by merged PR #1140.
72%
#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.
72%