docs: Reference document for the Service Factory
Metadata
Current evaluation
Merged documentation update adding a reference guide for the Service Factory. Approved by two reviewers, passed all CI checks, and changed 24 lines across two files. Minor discussion on method signature rendering was resolved.
Suggested action: —
No scores available.
Issue body
CRAFT-4508
Rendered: https://canonical-craft-application--1001.com.readthedocs.build/1001/reference/services/
- [ ] Have you followed the guidelines for contributing?
- [ ] 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 adding a reference guide for the Service Factory. Approved by two reviewers, passed all CI checks, and changed 24 lines across two files. Minor discussion on method signature rendering was resolved. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a reference document for the Service Factory. Maintainer confirmed that rendered method signatures displaying multiple overloads are expected and acceptable. PR closed after merge. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged documentation update adding a reference guide for the Service Factory. The maintainer confirmed that the verbose method signatures resulting from multiple overloads are expected and will remain in the generated docs. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #1002 docs: Reference document for the PackageService | craft-application | merged | Merged documentation update adding a reference guide for the PackageService. Approved by two reviewers, passed all CI checks, and modified three files. | |
| #1000 docs: add reference document for the ConfigService | craft-application | merged | Merged documentation update adding a reference guide for the ConfigService. Approved by two reviewers with all CI checks passing. The change adds 118 lines across six files and resolves CRAFT-4499. | |
| #75 refactor: pass the service factory to the services | craft-application | merged | Merged into main. Refactored service initialization to pass the ServiceFactory instance, enabling inter-service communication. Approved by two reviewers, passed CI, and achieved 100% diff coverage across 12 modified files. | |
| #654 refactor(ServiceFactory): de-dataclass the ServiceFactory | craft-application | merged | Merged a refactor removing the dataclass decorator from ServiceFactory, as it was only retained for historical registration methods. Approved by two reviewers, passed CI, and required PR #653. Modified 2 files. | |
| #40 services: allow the service factory to be created before the project. | craft-application | merged | Merged into main. Enables creating the service factory before the project. Approved by two reviewers, modified nine files with 65 additions and 13 deletions, and increased test coverage by 0.01%. |