← Back to issue list

feat(dispatcher): use the command docstring as the default overview

View original Github issue

Metadata

Project
craft-cli
Number
#518
Type
pull request
State
open
Author
18Abhinav07
Labels
—
Created
Updated
Closed
—

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

Fixes #253 If a command doesn't define `overview`, its own class docstring is used instead. Parent docstrings aren't picked up, and an explicit `overview` still wins. Commands without an overview used to fail validation, so nothing that works today changes. I left out the `help_msg` idea from the comments, since the help listing reads `help_msg` off the classes before they're instantiated. Happy to do it in a follow-up. I ran ruff, ty, codespell and the full test suite in a Linux container rather than `make lint && make test`. All clean: 918 passed, 2 skipped, same as main. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/craft-cli/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [ ] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [ ] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [x] I've updated the relevant release notes.

Evaluation history

No evaluation history available.

Update history

Date Change
updated
created

Related issues

No embedding available for this issue yet. Run scripts/run_llm.py evaluate to enable similarity search.