Documentation is missing the `Emitter` class
Metadata
Current evaluation
Emitter API documentation was restored by merged PR #212 in commit 9b9057c, adding Emitter and EmitterMode to the generated reference.
Resolution: closed resolved
Reason: PR #212 was merged as commit 9b9057c, adding a dedicated API reference for Emitter and EmitterMode. The closing maintainer comment also identifies #212 as the completed work.
Evaluated by: mr-cal-bot
No scores available.
Issue body
### Bug Description
The auto-generated documentation doesn't contain documentation for the `Emitter` class.
### To Reproduce
https://canonical-craft-cli.readthedocs-hosted.com/en/latest/search/?q=Emitter&check_keywords=yes&area=default
### part yaml
```shell
```
### Relevant log output
```shell
n/a
```
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Emitter API documentation was restored by merged PR #212 in commit 9b9057c, adding Emitter and EmitterMode to the generated reference. | |
| stealth/space-bunny-alpha | — | closed resolved | Missing Emitter API documentation was restored in merged PR #212 (commit 9b9057c), adding explicit references for Emitter and EmitterMode. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Documentation for the Emitter class was added and the issue was closed after being resolved in pull request #212. | |
| qwen/qwen3.8-27b |
Impact:
30
Quick Win:
27
Staleness:
70
Complexity:
10
Confidence:
85
Support Request:
0
|
close stale | Auto-generated Sphinx docs omit the Emitter class from the craft_cli.messages API reference. Fixed in commit 9b9057c which added docs/autodoc/craft_cli.messages.template explicitly documenting Emitter and EmitterMode. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
95
Complexity:
20
Confidence:
80
Support Request:
5
|
needs triage | Missing documentation for the Emitter class in auto-generated docs. Open for 517 days with no maintainer response, labels, or assignee, only automated Jira sync comments. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
90
Complexity:
10
Confidence:
80
Support Request:
5
|
close stale | Missing documentation for the Emitter class in auto-generated docs. Open for over 1.5 years with no maintainer response or labels. |
Update history
| Date | Change |
|---|---|
| closed |
Related work
-
Likely Fixed By:
canonical/craft-cli#212
(confidence 100%)
Merged documentation fix restoring the missing Emitter API reference in commit 9b9057c.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #212 docs: fix missing api reference for Emitter | craft-cli | merged | Merged PR #212 added a dedicated RST page exposing Emitter and EmitterMode despite messages.py’s restrictive __all__, fixing the missing API docs in commit 9b9057c. |