← Back to issue list

[docs] clarify when to use `message` and when to use `progress(..., permanent=True)`

View original Github issue

Metadata

Project
craft-cli
Number
#248
Type
issue
State
open
Author
lengau
Labels
Created
Updated
Closed

Current evaluation

Docs task to clarify when to use emit.message vs emit.progress(permanent=True). Triaged and assigned to a maintainer, but the docs now distinguish the two and emit.warning() was added, so the original confusion is largely addressed.

Suggested action: close stale

Reason: Inactive for ~2.2 years (last activity 810 days ago) and no longer applicable: docs/explanation/presenting-messages.rst now explicitly states message is 'for the final output of the running command' while progress/permanent=True is for important progress info, and the issue's own 'how to show a warning' example is now handled by the dedicated emit.warning() method (added via the referenced #256/#358). The long-term path forward the issue pointed to is complete.

Impact: 30 Quick Win: 24.0 Staleness: 85 Complexity: 20 Confidence: 72 Support Request: 10

Issue body

### What needs to get done Clarify when a developer should use `message` or when they should use `progress`. Example: Which is the correct way to show a warning? ### Why it needs to get done User confusion: https://github.com/canonical/craft-application/pull/302#discussion_r1562935131

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.8-27b
Impact: 30
Quick Win: 24.0
Staleness: 85
Complexity: 20
Confidence: 72
Support Request: 10
close stale Docs task to clarify when to use emit.message vs emit.progress(permanent=True). Triaged and assigned to a maintainer, but the docs now distinguish the two and emit.warning() was added, so the original confusion is largely addressed.
qwen/qwen3.6-35b-a3b
Staleness: 95
Complexity: 10
Confidence: 65
Support Request: 5
close stale Documentation task clarifying message versus progress usage. Assigned over two years ago but remains unlabelled and inactive with no maintainer follow-up.
qwen3.6-35b-a3b-mtp-q6
Staleness: 92
Complexity: 15
Confidence: 75
Support Request: 5
close stale Documentation task to clarify usage of message versus progress with permanent flag based on team guidelines. Currently assigned but inactive for over two years with no maintainer follow-up or labels.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 75
Support Request: 5
close stale Documentation update to clarify when to use message versus progress with permanent flag. Assigned to tigarmo to document the distinction between command output and warnings, resolving user confusion.

Update history

No update history recorded yet.

Related work

  • Related To: craft-cli#256 (confidence 80%)

    Issue cites #256 as the long-term path forward; #256 (Add emit.warning()) is closed and implemented, providing a dedicated warning method that supersedes the message/progress workaround for the warning example.

Related issues

No related issues found above the similarity threshold.