← Back to issue list

docs: fix missing api reference for Emitter

View original Github issue

Metadata

Project
craft-cli
Number
#212
Type
pull request
State
merged
Author
tigarmo
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: PR #212 was approved and merged, adding explicit autodoc directives for Emitter and EmitterMode in commit 9b9057c. It explicitly fixes canonical/craft-cli#208 and restored its missing messages API reference.

Evaluated by: mr-cal-bot

No scores available.

Issue body

The docs were missing because of the ``__all__`` attribute in ``messages.py``. To get around this, craft a special purpose rst file to be used when documenting that module, explicitly asking autodoc to generate docs for Emitter and EmitterMode. Fixes #208 - [ ] Have you followed the guidelines for contributing? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `tox`?

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #212 (commit 9b9057c) added a dedicated RST file documenting Emitter and EmitterMode, bypassing messages.py’s restrictive __all__ attribute. Fixes #208.
qwen/qwen3.6-35b-a3b — — Merged documentation fix resolving issue #208. Added a custom RST file to explicitly generate API references for Emitter and EmitterMode, bypassing __all__ restrictions in messages.py. Approved by reviewers and passed CI.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/craft-cli#208 (confidence 100%)

    PR #212 explicitly states that it fixes #208; the issue is closed by the merged documentation change.

Related issues

Issue Project State Summary Similarity
#328 Documentation is missing the `Emitter` class craft-cli closed Emitter API documentation was restored by merged PR #212 in commit 9b9057c, adding Emitter and EmitterMode to the generated reference.
78%