Update docs to use craft-parts features correctly
Metadata
Current evaluation
Merged PR #475 (commit d448c449) updated the partitions guide to remove production Features.reset() guidance and document the craft-parts feature override.
Resolution: closed resolved
Reason: The documentation corrections were merged through PR #475 in commit d448c449, resolving the outdated guidance described in #472.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### What needs to get done
Fix this: https://canonical-craft-application.readthedocs-hosted.com/en/latest/howto/partitions.html#required-application-changes
* `Features.reset()` shouldn't be called in production code.
* Applications should override `enable_craft_parts_features`.
### Why it needs to get done
Docs are not up to date.
(CRAFT-3325)
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #475 (commit d448c449) updated the partitions guide to remove production Features.reset() guidance and document the craft-parts feature override. | |
| stealth/space-bunny-alpha | — | closed resolved | Docs were fixed by merged PR #475 (commit d448c449), removing production Features.reset() guidance and documenting the _enable_craft_parts_features override. | |
| stealth/space-bunny-alpha | — | closed resolved | Updated the partitions guide in merged PR #475 (commit d448c449), removing production Features.reset() guidance and using the _enable_craft_parts_features override. | |
| stealth/space-bunny-alpha | — | closed stale | The documentation update remains unverified: its only follow-up was an automated link to internal ticket CRAFT-3390, with no linked resolving PR or commit found. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed and synced to JIRA ticket CRAFT-3390. Documentation corrections for craft-parts features were routed to the internal tracker without a direct repository fix or merge. | |
| qwen/qwen3.6-35b-a3b | — | — | Documentation updated to correctly use craft-parts features. Fixed instructions to override enable_craft_parts_features instead of calling Features.reset() in production code. |
Update history
No update history recorded yet.
Related work
-
Likely Fixed By:
canonical/craft-application#475
(confidence 100%)
Merged PR #475 contains commit d448c449, which corrected the partitions documentation.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #754 Document Partitions | craft-parts | closed | Partitions documentation was added and the issue completed by merged PR canonical/craft-parts#763 in commit cdcc9dbc. | |
| #371 docs: add howto for using partitions | craft-application | merged | Merged PR #371 in commit b99d1e83, adding a partition usage how-to and updating the documentation index (CRAFT-3068). | |
| #475 feat: update partitions docs | craft-application | merged | Merged #475 in d448c449, updating partition docs to remove Feature resets and Application method overrides, plus related usage cleanup. | |
| #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. | |
| #1195 docs: remove Craft Parts links from docstrings | craft-parts | merged | 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. | |
| #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. | |
| #763 partitions feature documentation | craft-parts | merged | Merged developer-facing partitions documentation in commit cdcc9dbc, completing CRAFT-3030 after approval by two reviewers. | |
| #1031 docs: add new how-to for parts | craft-parts | merged | Merged PR #1031 via commit 31a15e7e, adding a generalized Craft Parts how-to adapted from Snapcraft documentation and a changelog entry. | |
| #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"). | |
| #4811 build(deps): bump craft-parts to 1.31.0 | snapcraft | merged | Merged PR #4811 bumped craft-parts to 1.31.0 to add a new set of plugin docs; resolving merge commit a32f01a21. |