docs: add docstrings to Pydantic fields
Metadata
Current evaluation
Merged PR #153 into main as 8c94407, adding Pydantic field docstrings, the Kitbash documentation dependency, and a draft rendered YAML reference.
Resolution: closed resolved
Reason: PR #153 was approved and merged into main as commit 8c94407, completing the documentation changes despite one failing spread job.
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`?
---
[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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #153 into main as 8c94407, adding Pydantic field docstrings, the Kitbash documentation dependency, and a draft rendered YAML reference. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged into main as commit 8c94407 (PR #153), adding Pydantic field docstrings, Kitbash as a documentation dependency, and a rendered YAML reference. | |
| 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. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5972 docs: incorporate pydantic-kitbash 1.0.0 | snapcraft | merged | Merged PR #5972 in commit f441d1d64, updating pydantic-kitbash docs to 1.0.0, removing redundant label overrides, and revising YAML-key references. | |
| #1075 docs: incorporate pydantic-kitbash 1.0.0 | rockcraft | merged | Merged #1075 in 9ad107a0, upgrading pydantic-kitbash to 1.0.0 and updating YAML key references to its collision-safe label format. | |
| #5421 docs: add snapcraft.yaml reference | snapcraft | merged | Merged PR #5421 as commit 8a046bb00, adding generated snapcraft.yaml reference docs, project field docstrings, and pydantic-kitbash integration; the dependency was restored to PyPI before merge. | |
| #156 docs: update yaml reference | imagecraft | merged | Merged PR #156 as commit 1dbd410, automating the imagecraft.yaml reference with Kitbash and field docstrings added in PR #153. |