← Back to issue list

docs: replace keywords with keys

View original Github issue

Metadata

Project
craft-parts
Number
#1685
Type
pull request
State
merged
Author
cmatsuoka
Labels
Type: Documentation
Created
Updated
Closed

Current evaluation

Merged documentation update replacing keyword with key for consistent YAML terminology. Approved by two reviewers with all CI checks passing. Resolves issue 994 across 21 files.

Suggested action: —

No scores available.

Issue body

Change instances of the word "keyword" to "key" (in the context of YAML key-value definitions) to use correct and consistent terminology. Document anchors were not changed to prevent breaking external links. Fixes #994 - [x] Have you followed the guidelines for contributing? - [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `make lint && make test`? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? ---

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b — — Merged documentation update replacing keyword with key for consistent YAML terminology. Approved by two reviewers with all CI checks passing. Resolves issue 994 across 21 files.
qwen/qwen3.6-35b-a3b — — Merged documentation update replacing keyword with key for consistent YAML terminology. Document anchors were preserved to maintain external link integrity. Resolves issue 994. Approved by two reviewers with all CI checks passing.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 95
needs review Replaces keyword with key in YAML documentation for terminology consistency. Fixes #994. Approved by one reviewer, all CI checks passing, ready to merge.
qwen/qwen3.6-35b-a3b
Staleness: 0
Complexity: 5
Confidence: 95
needs review Replaces 'keyword' with 'key' in documentation for YAML key-value contexts to improve terminology consistency. All CI checks pass. Awaiting maintainer review.
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 85
needs review Replaces keyword with key in documentation for YAML definitions. Fixes issue 994. Author is a maintainer. CI checks are pending and no reviewer comments exist.

Update history

Date Change
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#994 Docs: Replace "keywords" with "keys" craft-parts closed Closed. Documentation terminology was updated to replace keywords with keys for consistency. Fixed without a linked pull request.
79%
#5849 docs: fix YAML reference types snapcraft merged Merged documentation fix correcting YAML reference types. Approved by two reviewers, passed all CI checks, and updated one file with six additions and two deletions.
78%
#466 docs: fix yaml in examples craft-parts merged Merged a documentation fix correcting YAML syntax in example parts.yaml by replacing underscores with hyphens. Approved by reviewer, passed CI, and changed two lines in one file.
74%
#814 docs: maintain project file terminology rockcraft merged Merged documentation update standardizing terminology by replacing recipe with project file and field with key. Adjusted code block formatting and added captions across 27 files. Approved and passed CI.
73%
#2154 docs: replace occurrences of "charmcraft.yaml" and "recipe" charmcraft merged Merged documentation update replacing charmcraft.yaml and recipe with project or project file across 23 files. Approved by two reviewers after minor clarity feedback. Changes span +155/-159 lines.
72%
#5681 docs: document the base key snapcraft merged Merged documentation update adding 17 lines to document the base key. Approved by two reviewers with zero unresolved comments. CI passed except for one non-blocking test.
71%
#2169 docs: replace "recipe" as a term charmcraft merged Merged documentation update replacing the term recipe across seven files. Addresses leftover work from CRAFT-4000, approved by two reviewers, and incorporates lint fixes prior to final merge.
71%
#144 docs: update meta description guidelines starflow merged Merged documentation update applying the latest meta description guidelines and examples. Approved by one reviewer with all CI checks passing. Changes span three files, adding 43 lines and removing 47.
71%
#5637 docs: fix CONTRIBUTING.md typos snapcraft merged Merged documentation update correcting typos and internal links in CONTRIBUTING.md. Approved by two reviewers, passed CI checks, and applied with a minimal three-line change.
71%
#919 docs: fix indentation craft-application merged Merged documentation fix correcting an indentation error introduced in a prior review. Approved by two reviewers, passed all CI checks, and applied a minimal two-line change.
70%