← Back to issue list

docs: normalise plugin references

View original Github issue

Metadata

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

Current evaluation

Merged PR #1349 by maintainer jahn-junior normalised plugin docs across 30 files (+702/-545): whitespace, singular "Example" headings, harmonised Unset markers, and replaced :file:/:command: roles. Merged as commit 022d23cb.

Resolution: closed resolved

Reason: The PR itself was merged into the main branch as commit 022d23cb ("docs: normalise plugin references (#1349)"), after @medubelko commented "Should be good to merge." on 2025-10-08 and all CI/lint checks passed.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you followed the guidelines for contributing? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [X] Have you successfully run `make lint && make test`? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? --- * Standardize whitespace in plugin docs * Change "Examples" heading to "Example" when only one is present * Harmonize `[]`, `""`, and `Unset` * Replace `:file:` and `:command:` roles (probably out-of-scope but I couldn't help myself) I'll also wrap all of the lines at 88 characters once the review is complete. I didn't want to obscure the actual changes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #1349 by maintainer jahn-junior normalised plugin docs across 30 files (+702/-545): whitespace, singular "Example" headings, harmonised Unset markers, and replaced :file:/:command: roles. Merged as commit 022d23cb.
stealth/space-bunny-alpha — closed resolved Merged PR #1349 normalized plugin documentation across 30 files, standardizing whitespace, singular example headings, unset values, and file/command roles; all CI checks passed.
qwen/qwen3.6-35b-a3b — — Documentation references for plugins were normalized across 30 files by standardizing whitespace, headings, and formatting roles. The changes were approved by two reviewers, passed all CI checks, and successfully merged.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates that normalize plugin references, standardize whitespace, harmonize formatting symbols, and replace Sphinx roles. Approved by reviewer and integrated into the main branch.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1573 docs: rename plugins '* use' -> '*-use' craft-parts merged Merged PR #1573 as commit e8483123, standardizing plugin human names from '* use' to '*-use' in documentation.
75%
#5809 docs: format plugin references snapcraft merged Merged in PR #5809 via commit f1e95626e, standardizing plugin-reference docs with “Keys” headings, consistent whitespace and lists, and an updated Maven example.
73%
#410 docs/plugins.md: Update for new plugin API. snapcraft merged Merged PR #410 updated docs/plugins.md for the current plugin API, resolving Launchpad #1561524; documentation commit 862e96893.
70%