Document the pytest plugin
Metadata
Current evaluation
The pytest plugin has a basic how-to, but autodoc excludes it and its fixtures and assertion API remain incompletely documented; the enhancement is still open.
Suggested action: keep open
Reason: The maintainer-authored request is labeled as a documentation enhancement, and the current how-to only explains the two fixtures and demonstrates assert_trace. The Sphinx apidoc configuration explicitly excludes pytest_plugin, while the how-to links to RecordingEmitter without a generated API page, so fuller documentation remains warranted.
Evaluated by: mr-cal-bot
Impact:
28
Quick Win:
15
Complexity:
24
Confidence:
93
Actionability:
72
Issue body
### What needs to get done
Write documentation about how to use the craft-cli pytest plugin
### Why it needs to get done
This is currently undocumented.
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha |
Impact:
28
Quick Win:
15
Complexity:
24
Confidence:
93
Actionability:
72
|
keep open | The pytest plugin has a basic how-to, but autodoc excludes it and its fixtures and assertion API remain incompletely documented; the enhancement is still open. | |
| qwen/qwen3.6-35b-a3b |
Impact:
30
Quick Win:
22
Complexity:
10
Confidence:
90
Actionability:
80
|
keep open | Documentation gap for the craft-cli pytest plugin. The plugin at craft_cli/pytest_plugin.py provides fixtures (init_emitter, emitter) and RecordingEmitter class with multiple assertion methods, but only minimal docs exist at docs/how-to/unit-test-with-emitter.rst. | |
| qwen/qwen3.8-27b |
Impact:
20
Quick Win:
18
Staleness:
70
Complexity:
10
Confidence:
75
Support Request:
0
|
close not a bug | Request to document the craft-cli pytest plugin (init_emitter/emitter fixtures). Documentation now exists at docs/how-to/unit-test-with-emitter.rst and is linked in the how-to index, so the ask appears fulfilled. | |
| qwen/qwen3.6-35b-a3b |
Staleness:
85
Complexity:
15
Confidence:
80
Support Request:
5
|
keep open | Request to document the craft-cli pytest plugin. Currently undocumented and opened by a maintainer, but has been inactive for over a year with only a Jira sync comment. | |
| qwen3.6-35b-a3b-mtp-q6 |
Staleness:
75
Complexity:
20
Confidence:
85
Support Request:
0
|
needs triage | Request to document the craft-cli pytest plugin. Currently lacks maintainer assessment, assignee, or prioritization after nearly two years of inactivity. |
Update history
No update history recorded yet.
Related issues
No related issues found above the similarity threshold.