← Back to issue list

chore: update docstrings

View original Github issue

Metadata

Project
debcraft
Number
#158
Type
pull request
State
merged
Author
cmatsuoka
Labels
—
Created
Updated
Closed

Current evaluation

PR #158 by cmatsuosa merged as commit cbca713, adding missing parameter and return value entries to public function docstrings across 10 files (+55/-9). Follow-up commit 0d328c4 relaxed docstring rules for overrides.

Resolution: closed resolved

Reason: The pull request itself was merged into main as commit cbca713 ("chore: update docstrings (#158)") after approval by two reviewers, with all lint, fast/slow test, and schema checks passing. A follow-up commit 0d328c4 added style ignores for docstring requirements on override methods, completing the documentation cleanup.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Add missing parameters and return values to public function docstrings. - [ ] 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`? ---

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR #158 by cmatsuosa merged as commit cbca713, adding missing parameter and return value entries to public function docstrings across 10 files (+55/-9). Follow-up commit 0d328c4 relaxed docstring rules for overrides.
stealth/space-bunny-alpha — closed resolved Merged PR #158 updated public-function docstrings with missing parameters and return values across 10 files (+55/-9), after approval by two reviewers.
qwen/qwen3.6-35b-a3b — — Merged updates to public function docstrings, adding missing parameters and return values. Approved by two reviewers, passed CI checks, and modified 10 files with 55 additions and 9 deletions.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/debcraft#159 (confidence 55%)

    Commit 0d328c4 "style: ignore docstring requirements for overrides (#159)" landed right after this PR, relaxing docstring lint rules that this change likely triggered

Related issues

Issue Project State Summary Similarity
#621 chore: update fileset and organize docstrings craft-parts merged PR #621 was merged as commit c15e8dff, updating fileset documentation and reorganizing docstrings across two files (+22/-9).
82%
#773 chore: documentation polish craft-parts merged PR #773 merged documentation-only polishing: 32 additions and 11 deletions across two files, after approval by two reviewers.
78%
#162 chore: add fields and docstrings to package repository models craft-archives merged Merged PR #162 as commit 4c16960, adding fields and docstrings to package repository models; minimum-dependency test failures were noted as unrelated.
77%
#340 chore(deps): update documentation dependencies rockcraft closed Closed unmerged after 3+ years; newer documentation dependencies were later merged in PR #538 (commit b007f265).
75%
#364 chore(deps): update dependencies rockcraft merged Merged dependency updates in PR #364 via commit 1661d115, changing seven files (+152/-174) after approval by two reviewers.
75%
#5447 chore: rebase docs migration against main snapcraft merged Merged PR #5447, rebasing the documentation migration onto main and updating 174 files (+7,268/-640) after one approval.
75%
#1371 chore: update docs code ownership craft-parts closed Closed unmerged after an accidental upstream branch; replacement #1372 merged the documentation ownership filtering update in commit 3d369498.
75%
#2028 chore: two small non-code changes charmcraft merged Merged PR #2028 incorporated two small non-code updates across two files (+5/-2), with approval from two reviewers.
74%
#1776 chore: remove unused code charmcraft merged Merged PR #1776 as commit 027696be, deleting 17,571 lines of unused code across 36 files after maintainer review and approval.
74%
#529 chore: fix doc and yaml linting craft-parts merged Merged #529 as commit 81dc87bd, fixing documentation and YAML linting in three files. Verification used tox -m lint; lint enforcement in CI remained disabled.
73%