← Back to issue list

docs: fix component type in the howto

View original Github issue

Metadata

Project
snapcraft
Number
#5179
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #5179 in commit 155753d52, correcting the component type in the organize-howto snapcraft.yaml example missed by #5174.

Resolution: closed resolved

Reason: PR #5179 was approved and merged as commit 155753d52, fixing the one-line documentation error in components-organize/snapcraft.yaml.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [x] Have you successfully run `tox run -m lint`? - [x] Have you successfully run `tox run -e test-py310`? (supported versions: `py39`, `py310`, `py311`, `py312`) ----- Minor fix. In #5174, I updated the type in `docs/howto/code/components/snapcraft.yaml` but not `docs/howto/code/components-organize/snapcraft.yaml`.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #5179 in commit 155753d52, correcting the component type in the organize-howto snapcraft.yaml example missed by #5174.
stealth/space-bunny-alpha — closed resolved Merged in commit 155753d52: corrected the component type in the organize-howto snapcraft.yaml example, fixing a documentation omission from #5174.
qwen/qwen3.6-35b-a3b — — Merged a documentation fix correcting the component type in docs/howto/code/components-organize/snapcraft.yaml. The change followed up on PR 5174, passed all CI checks, and received approval from three reviewers before being merged.
qwen3.6-35b-a3b-mtp-q6 — — Merged a documentation fix updating the missing component type in docs/howto/code/components-organize/snapcraft.yaml to match a prior change.

Update history

No update history recorded yet.

Related work

  • Caused By: snapcraft#5174 (confidence 99%)

    PR #5174 updated the corresponding components example but omitted the organize example corrected here.

Related issues

Issue Project State Summary Similarity
#5757 docs: add docs for setting component versions snapcraft merged Merged PR #5757 as commit ffb793a0e, adding a Snapcraft 8.13 component-version release note and linking the component guide to the craftctl how-to.
75%
#5571 docs: update 'snapcraft.yaml' key types snapcraft merged Merged PR #5571 updated snapcraft.yaml type presentation for parts, components, and package repositories, and added missing build-attributes headers.
74%
#5174 docs: update component documentation snapcraft merged Merged PR #5174 in commit f028b3d79 documented component types and runtime mounting and replaced the deprecated test type example with standard, fixing #5162.
72%
#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.
71%
#6283 docs: fix syntax for H1 heading snapcraft merged Merged docs-only typo fix to an H1 heading syntax in Snapcraft documentation. Merged to main as commit a85c8fdf8 (PR canonical/snapcraft#6283), a +1/-1 line change with no functional impact.
70%