docs: add docstrings to Pydantic fields
Metadata
Current evaluation
Merged after approval from two reviewers. Adds docstrings to Pydantic fields, includes Kitbash as a documentation dependency, and drafts a YAML reference. CI passed with minor spread test failures. Changes integrated into the main branch.
Suggested action: —
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`?
---
[RTD build](https://canonical-imagecraft--153.com.readthedocs.build/en/153/imagecraft-yaml/)
* added Kitbash as a doc dependency
* added docstrings to Pydantic fields
* drafted YAML reference so reviewers can see rendered docstrings
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after approval from two reviewers. Adds docstrings to Pydantic fields, includes Kitbash as a documentation dependency, and drafts a YAML reference. CI passed with minor spread test failures. Changes integrated into the main branch. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding docstrings to Pydantic fields. Kitbash was added as a documentation dependency and a draft YAML reference was included to verify rendered output. All lint and test checks passed. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding docstrings to Pydantic fields and introducing Kitbash as a documentation dependency. Includes a drafted YAML reference for review. Lint and test checks passed. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #259 docs: incorporate Kitbash 1.0 | imagecraft | merged | Merged documentation update upgrading pydantic-kitbash to v1.0 and renaming the YAML reference file. Approved by three reviewers with passing CI checks. An unrelated snap build failure was noted but did not prevent the merge. | |
| #5972 docs: incorporate pydantic-kitbash 1.0.0 | snapcraft | merged | Merged following approval by two reviewers. Updated pydantic-kitbash to 1.0.0, removed redundant label overrides, and updated YAML key references to match the new label format. Six files changed. | |
| #1075 docs: incorporate pydantic-kitbash 1.0.0 | rockcraft | merged | Merged an upgrade to pydantic-kitbash 1.0.0, updating YAML key references to match the new label format and fixing literalref spacing. Approved by reviewers and passed CI checks. | |
| #1149 docs: update 'Part properties' | craft-parts | merged | Merged documentation update for Part properties. Added pydantic-kitbash as a docs dependency, refreshed content, and updated targets across the doc set. Approved by three reviewers and passed all CI checks. | |
| #913 Update dependencies, bring in pydantic-kitbash | rockcraft | merged | Merged after two approvals and passing all CI checks. The update refreshes dependencies and integrates pydantic-kitbash, modifying ten files with 3588 additions and 393 deletions. | |
| #55 docs: fix document generation | craft-parts | merged | Merged following approval by two reviewers and successful CI checks. Added a documentation-specific requirements list to resolve Sphinx generation failures for Pydantic classes, modifying five files. | |
| #1501 build(docs): update and clean docs dependencies | craft-parts | merged | Merged following approval by three reviewers. Updated and cleaned documentation dependencies, removing sphinx-pydantic in favor of pydantic-kitbash. All required CI checks passed. | |
| #486 docs: fixed broken references | craft-parts | merged | Merged after rebasing on main to resolve a mypy test failure caused by a pydantic 2.0 update. Approved by three reviewers, the change fixes broken documentation references across four files. | |
| #401 build!: update to pydantic 2 | craft-application | merged | Merged to update the codebase to Pydantic 2. Approved by two reviewers and passed CI. The change modified 23 files (+531/-342). Initial test failures were resolved after the craft-grammar dependency received a corresponding update. | |
| #245 docs: clean up 'imagecraft.yaml' | imagecraft | merged | Merged documentation cleanup for imagecraft.yaml. Updates include upgrading pydantic-kitbash to v0.1.1, removing legacy workarounds, fixing typos, and refining docstrings. Approved by two reviewers and successfully merged. |