← Back to issue list

docs: avoid warnings by using autosummary instead of apidoc

View original Github issue

Metadata

Project
craft-parts
Number
#418
Type
pull request
State
closed
Author
dboddie
Labels
—
Created
Updated
Closed

Current evaluation

Closed unmerged; its autosummary/apidoc documentation approach was replaced by PR #452, which fixed the apidoc warnings in commit 7e035f5f.

Resolution: closed superseded

Reason: PR #418 was closed after maintainer @dboddie said on 2023-05-01 that they would try a different approach in a new PR. The later warning fix merged through PR #452 in commit 7e035f5f.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? -----

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed superseded Closed unmerged; its autosummary/apidoc documentation approach was replaced by PR #452, which fixed the apidoc warnings in commit 7e035f5f.
stealth/space-bunny-alpha — closed superseded Closed unmerged after two unresolved review comments; maintainer @dboddie said the documentation change would be replaced by a different approach in a new PR.
qwen/qwen3.6-35b-a3b — — Closed without merging. The author abandoned the documentation fix to pursue a different approach in a new pull request.
qwen3.6-35b-a3b-mtp-q6 — — Closed without merging. The autosummary approach to fix documentation warnings was abandoned, with the author opting to implement an alternative solution in a separate pull request.

Update history

No update history recorded yet.

Related work

  • Superseded By: canonical/craft-parts#452 (confidence 95%)

    Its merged commit, 7e035f5f, is titled "docs: fix apidoc warnings" and addresses the same documentation-warning problem.

Related issues

Issue Project State Summary Similarity
#452 docs: fix apidoc warnings craft-parts merged Merged PR #452 fixed apidoc warnings across nine documentation files (+59/-23) in commit 7e035f5f.
80%