← Back to issue list

docs: remove command output example

View original Github issue

Metadata

Project
charmcraft
Number
#2432
Type
pull request
State
merged
Author
bepri
Labels
Created
Updated
Closed

Current evaluation

Merged after two approvals. Removed a command output example from documentation to align with other commands and prevent help text instability. Closes #2375. CI passed except one macOS smoke test, which did not block the merge.

Suggested action:

No scores available.

Issue body

Closes #2375. This PR just removes the example given, as similar tabulated commands do not have output examples (see [snapcraft status](https://documentation.ubuntu.com/snapcraft/stable/reference/commands/status/)) and anything beyond simple text is pretty unstable to use in our help messages.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged after two approvals. Removed a command output example from documentation to align with other commands and prevent help text instability. Closes #2375. CI passed except one macOS smoke test, which did not block the merge.
qwen3.6-35b-a3b-mtp-q6 Merged documentation update removing an unstable command output example to align with other reference commands. Closes #2375. A non-blocking type checking notification was noted but did not prevent the merge.
qwen3.6-35b-a3b-mtp-q6 Merged. Removes an unstable command output example from help messages to align with similar commands and close #2375. A non-actionable type checking notification did not block the merge.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#4267 docs: add command reference snapcraft merged Merged after two approvals and passing CI. Added command reference documentation across 10 files. Required merging prerequisite PR #4272 to fix ReadTheDocs builds before updating the branch and finalizing the merge.
75%
#1079 docs: fix terminal directive craft-application merged Merged a one-line documentation fix correcting the terminal directive rendering for multiline input. Approved by one reviewer with all CI checks passing.
71%
#452 fix: don't recommend hidden commands craft-cli merged Merged fix preventing hidden commands from appearing in the 'See also' section of command help text. Resolves issue #449. Approved by two reviewers with all CI checks passing. Modified three files.
70%
#5576 docs: ignore deprecated command pages snapcraft merged Merged a documentation update that adds deprecated command pages to the exclude_patterns configuration. Approved by two reviewers and passed CI checks, successfully excluding legacy command documentation from generation.
70%