← Back to issue list

Missing documentation for attributes of `craft_cli.dispatcher.BaseCommand`

View original Github issue

Metadata

Project
craft-cli
Number
#86
Type
issue
State
open
Author
jugmac00
Labels
Created
2022-06-20 09:08:42+00:00
Updated
2025-03-10 18:59:12+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

A colleague created a [MP](https://code.launchpad.net/~cjwatson/lpcraft/+git/lpcraft/+merge/424297) to make use of the craft-cli command dispatcher. There he uses several attributes of `BaseCommand`. When I have a look at the current [documentation](https://craft-cli.readthedocs.io/en/latest/craft_cli.dispatcher.html#craft_cli.dispatcher.BaseCommand.help_msg), the attributes are not yet documented, ie `common`, `help_msg`, and `overview`. Could you please add some documentation? see https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html Thank you! **Update** My colleague told me the attributes are documented within the class' docstring :-/ Looks like I got confused as you document the methods in the method docstring, but the attribute not in a "attribute docstring" (see linked Sphinx documentation), but rather in the class docstring. I usually do not read an API documentation from top to bottom, but directly go to the information I want to look up.

Evaluation history

No evaluation history available.