← Back to issue list

docs: remove Craft Parts links from docstrings

View original Github issue

Metadata

Project
craft-parts
Number
#1195
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

PR #1195 merged as commit fa440b8c, stripping Craft Parts links from PartSpec field docstrings so downstream consumers can supply versioned internal references; changelog entry added under2.20.0.

Resolution: closed resolved

Reason: The pull request was approved by three reviewers with all CI checks passing and merged to main as commit fa440b8c ("docs: remove Craft Parts links from docstrings (#1195)"). Per reviewer request from tigarmo, a changelog entry was added, appearing in docs/reference/changelog.rst under the 2.20.0 release notes.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [X] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? ----- Remove Craft Parts links from field docstrings These links should be replaced downstream as internal references to ensure that they are properly versioned and resistant to breakage.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved PR #1195 merged as commit fa440b8c, stripping Craft Parts links from PartSpec field docstrings so downstream consumers can supply versioned internal references; changelog entry added under2.20.0.
stealth/space-bunny-alpha — closed resolved Merged PR #1195 (commit fa440b8c), removing Craft Parts links from field docstrings so downstream documentation can use versioned internal references.
stealth/space-bunny-alpha — closed resolved Merged in commit fa440b8c, removing Craft Parts links from field docstrings so downstream builds can use versioned internal references; a changelog entry was added.
qwen/qwen3.6-35b-a3b — — Merged after reviewer approval and passing CI. Removed Craft Parts links from docstrings, replacing them with internal references for proper versioning and resilience. A changelog entry was added per reviewer request.
qwen3.6-35b-a3b-mtp-q6 — — Merged after removing Craft Parts links from docstrings to enable downstream replacement with versioned internal references. A changelog entry was added per reviewer request.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#314 docs: clean up references to Craft Parts rockcraft closed Craft Parts documentation cleanup was folded into canonical/rockcraft#308, merged as commit 13bf8368, and #314 was closed.
76%
#1104 docs: update links craft-parts merged Merged broken-link documentation fixes in craft-parts#1104 via commit 95a2b69a, updating two documentation files (+3/-1).
74%
#1266 docs(changelog): Release 2.22.0 craft-parts merged Merged documentation-only PR craft-parts#1266 (commit 6d8383c8) adding the craft-parts 2.22.0 changelog entry to docs/reference/changelog.rst; approved by 2 reviewers with all CI checks green.
74%
#472 Update docs to use craft-parts features correctly craft-application closed Merged PR #475 (commit d448c449) updated the partitions guide to remove production Features.reset() guidance and document the craft-parts feature override.
73%
#247 docs: include some docs from craft-parts rockcraft closed PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts").
72%
#4679 refactor(docs): use more docs from craft-parts snapcraft merged Merged #4679 as b8c9a17dc, replacing duplicated Snapcraft docs with direct craft-parts TOC references or includes for shared content.
72%
#905 docs(changelog): release 2.1.3 craft-parts merged Merged craft-parts 2.1.3 release documentation in commit 38738eda, including fixes from #872 and documentation-linter cleanup.
72%
#1184 docs: Release 2.19.0 craft-parts merged Merged release PR #1184 (commit 70aab68d) adding the Craft Parts 2.19.0 changelog entry dated 2025-07-24; released after fix PR #1185 landed.
72%
#404 docs: add an explanation of parts craft-parts merged Merged PR #404 as commit d7089838, adding 628 lines across nine files to explain Craft Parts.
72%
#1021 docs: prevent transclusion issues craft-parts merged Merged canonical/craft-parts#1021, updating two documentation files to prevent transclusion problems in downstream applications.
72%