extensions: use extension docstring
Metadata
Current evaluation
Merged PR #2349 in commit 6e7e30ee1, making snapcraft extensions display extension-specific docstrings and resolving LP #1797655.
Resolution: closed resolved
Reason: The approved change was merged as commit 6e7e30ee1; the PR states that it resolves LP #1797655 by using documentation supplied by each extension.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] If this is a bugfix. Have you checked that there is a bug report open for the issue you are trying to fix on [bug reports](https://bugs.launchpad.net/snapcraft)?
- [x] If this is a new feature. Have you discussed the design on the [forum](https://forum.snapcraft.io)?
- [x] Have you successfully run `./runtests.sh static`?
- [x] Have you successfully run `./runtests.sh tests/unit`?
-----
Currently, `snapcraft extension` is not the most obvious description of what the extension does or how to use it. This PR resolves [LP: #1797655](https://bugs.launchpad.net/snapcraft/+bug/1797655) by using documentation provided by the extension instead.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2349 in commit 6e7e30ee1, making snapcraft extensions display extension-specific docstrings and resolving LP #1797655. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2349 in commit 6e7e30ee, replacing the generic extension description with extension-specific docstrings and resolving LP #1797655. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged snapcore/snapcraft#2349, making `snapcraft extension` use extension-provided docstrings for clearer descriptions and resolving LP #1797655. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #2349 as commit 6e7e30ee1, making `snapcraft extension` show extension-provided docstrings and resolving LP bug #1797655. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged into master. Replaces the generic snapcraft extension description with extension-specific docstrings, resolving bug LP: #1797655. Approved by reviewer and passed all CI checks. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged updates to the snapcraft extension command to display extension docstrings instead of hardcoded descriptions. Resolves LP: #1797655. Author kyrofa passed all tests with 100% diff coverage. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2706 extensions: improve docsting (used in the cli) | snapcraft | merged | Merged PR #2706 in commit 91a4b4036, improving the gnome-3-28 extension description and its `snapcraft extension` CLI help. | |
| #1797655 `snapcraft extension` should be completely provided by the extension | snapcraft (launchpad) | closed | Fixed by snapcore/snapcraft PR #2349 (merged as commit 6e7e30ee1, "extensions: use extension docstring"): `snapcraft extension` help output now comes from the extension's own docstring. | |
| #3679 Expand extensions | snapcraft | merged | Merged PR snapcore/snapcraft#3679 via commit 07a8d695c, expanding extensions for CRAFT-948 in the snapcraft/7.0 branch. | |
| #4705 docs(extensions): improve docstrings and comments | snapcraft | merged | Merged doc-only PR canonical/snapcraft#4705 via commit 3b9704563, clarifying extension docstrings/comments about the `builtin` parameter in the GNOME extension. | |
| #3781 extensions: refactor | snapcraft | merged | Merged in snapcraft#3781 via commit 986a9895b (merge 52155ff01), centralizing extension checks in the base class to prevent future cyclic imports. | |
| #2350 extensions: parse all declared extensions before applying | snapcraft | merged | Merged in snapcore/snapcraft#2350 (commit 7e0391d40), parsing all declared extensions before applying any to fix LP #1797638. | |
| #2347 extensions: support adding root properties | snapcraft | merged | Merged PR #2347 as commit 482bffb1c, allowing extensions to add root-level snapcraft.yaml properties such as plugs and slots; resolves LP #1794531. | |
| #4110 extensions: parse snapcraft.yaml before expanding extensions | snapcraft | merged | Merged #4110 (commit 51ca1524b): expand-extensions now parses snapcraft.yaml before expansion, fixing valid core22 files that use parse-info and advanced grammar keywords. | |
| #292 extensions: add cli commands | rockcraft | merged | Merged PR #292 (commit e8858077) added `list-extensions` and `expand-extensions` CLI commands with Snapcraft-equivalent semantics, plus test-data refactoring; closed rockcraft#274. | |
| #3810 extensions: method to get data dir | snapcraft | merged | PR #3810 (CRAFT-1115) merged as commit 0f230edc0, adding get_extensions_data_dir() to snapcraft/extensions/extension.py returning Path(sys.prefix)/share/snapcraft/extensions; now used by gnome, kde_neon, gpu, ros2 and dotnet extensions. |