← Back to issue list

Documentation doesn't describe which keys can use advanced grammar

View original Github issue

Metadata

Project
snapcraft
Number
#5995
Type
issue
State
open
Author
waveform80
Labels
Status: Triaged Type: Documentation
Created
Updated
Closed
—

Current evaluation

Documentation gap: snapcraft's advanced grammar reference page doesn't list which keys support it. A volunteer (@caglarkc) has been assigned by a maintainer (@mr-cal) to document the supported keys.

Suggested action: keep open

Reason: This is a valid, triaged documentation issue with a clear scope and an assigned volunteer (@caglarkc). Maintainer @mr-cal approved the scope on 2026-10-15 and pingged the documentation team for assignment. The issue is actionable and should remain open until the documentation PR is submitted.

Evaluated by: mr-cal-bot

Impact: 30 Quick Win: 22 Complexity: 10 Confidence: 90 Actionability: 80

Issue body

Where can the advanced grammar be used? This is never defined by the documentation, merely hinted at by the examples. From the examples, we can see `build-packages` and `build-environment` can be affected, but the text is vague enough to imply this *might* be useable elsewhere? Though, when attempting this with `parts.*.cmake-parameters` apparently that's not one of the places it works. --- *Reported from: https://documentation.ubuntu.com/snapcraft/stable/reference/advanced-grammar/*

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 22
Complexity: 10
Confidence: 90
Actionability: 80
keep open Documentation gap: snapcraft's advanced grammar reference page doesn't list which keys support it. A volunteer (@caglarkc) has been assigned by a maintainer (@mr-cal) to document the supported keys.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 22
Complexity: 12
Confidence: 88
Actionability: 85
keep open Docs gap: reference/advanced-grammar.rst never lists which part keys actually support advanced grammar. Triaged, maintainer confirmed it is undocumented; split-off feature request is #6064.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 17
Complexity: 20
Confidence: 75
Actionability: 70
keep open Documentation gap: advanced grammar scope is unclear which keys support it. Maintainer acknowledged the gap and clarified the intended behavior.
qwen/qwen3.8-27b
Impact: 35
Quick Win: 30
Staleness: 45
Complexity: 15
Confidence: 80
Support Request: 20
keep open Docs gap: advanced-grammar reference never lists which snapcraft.yaml keys support the syntax (only hinted via examples). Maintainer confirmed the omission and pointed to a separate feature request for broader key coverage; doc fix still pending.
qwen/qwen3.6-35b-a3b
Staleness: 60
Complexity: 20
Confidence: 85
Support Request: 10
keep open Documentation gap regarding which snapcraft.yaml keys support advanced grammar. Maintainer acknowledged the lack of documentation and suggested splitting the feature request to expand grammar usage into a separate issue. Currently awaiting further action or documentation update.
qwen3.6-35b-a3b-mtp-q6
Staleness: 50
Complexity: 10
Confidence: 85
Support Request: 0
keep open Documentation gap detailing which snapcraft.yaml keys support advanced grammar. Maintainer clarified scope but docs remain unupdated. Issue is triaged and valid, awaiting documentation update.

Update history

Date Change
updated
updated

Related issues

Issue Project State Summary Similarity
#6064 Extend advanced grammer to all keys of snapcraft snapcraft open Advanced grammar remains limited to selected keys, limiting clean architecture-specific apps, part omission, and plugin parameters. The feature is untriaged; plugin-parameter support is tracked in craft-application #985.
80%
#985 Support Snapcraft advanced grammar in plugin parameters? craft-application open Enhancement to apply advanced grammar to dynamically named plugin parameters; acknowledged as valid, clearly reproduced, and still awaiting implementation and tests.
71%