← Back to issue list

docs: the messages module is missing references

View original Github issue

Metadata

Project
craft-cli
Number
#208
Type
issue
State
closed
Author
sergiusens
Labels
—
Created
Updated
Closed

Current evaluation

Fixed in commit 9b9057c by adding a custom autodoc template that explicitly documents Emitter and EmitterMode despite messages.__all__.

Resolution: closed resolved

Reason: Commit 9b9057c added the missing messages API references by explicitly including Emitter and EmitterMode in the autodoc template.

Evaluated by: mr-cal-bot

No scores available.

Issue body

A picture is worth a 1000+ words What I see ![image](https://github.com/canonical/craft-cli/assets/1146853/f4800568-c014-4d0f-a0b7-5a7abb282e5d) what is missing ![image](https://github.com/canonical/craft-cli/assets/1146853/ae850751-bcf6-4c93-b96e-8b6613ba7980) --- *Reported from: https://canonical-craft-cli.readthedocs-hosted.com/en/latest/craft_cli.messages/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Fixed in commit 9b9057c by adding a custom autodoc template that explicitly documents Emitter and EmitterMode despite messages.__all__.
stealth/space-bunny-alpha — closed resolved Fixed the missing messages API documentation for Emitter in commit 9b9057c.
stealth/space-bunny-alpha — closed resolved Missing messages API references were fixed in commit 9b9057c by adjusting the overly restrictive __all__ list.
qwen/qwen3.6-35b-a3b — — Resolved by adjusting the __all__ list in the messages module, which was too restrictive and blocked documentation generation. Updating __all__ to expose missing exports fixes the reference gap.
qwen/qwen3.6-35b-a3b — — Closed after the author diagnosed that the module's __all__ export list was too strict, hiding documentation references. Resolved by adjusting the exports to expose the missing items.
qwen/qwen3.6-35b-a3b — — Resolved by adjusting the __all__ export list in the messages module to expose missing references. Documentation now correctly displays the expected API elements.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.