snap: update description #165
Conversation
Resolves canonical#164.
| version Show version details | ||
|
|
||
| Action (make things happen): | ||
| cut Cut a tree with selected slices |
There was a problem hiding this comment.
| cut Cut a tree with selected slices | |
| cut Cut a package with selected slices |
There was a problem hiding this comment.
AFAIK "cut a tree with selected slices" is what is currently printed when you run chisel help --all.
There was a problem hiding this comment.
Yup, it's copied from the help. :)
There was a problem hiding this comment.
There is the question of whether we want to change the description of the commands or add more information. In my opinion, that can wait until next cycle where we will have a focus on documentation. For now it seems like an easy win to update the snap to contain the same information that the CLI has.
Thanks Rafid for this UX improvements!
| @@ -12,11 +12,16 @@ description: | | |||
|
|
|||
| Commands can be classified as follows: | |||
|
|
|||
| Basic: help, version | |||
| Action: cut | |||
| Basic (general operations): | |||
There was a problem hiding this comment.
Why do we have this information in the snap description at all? This is not conventional for snaps or packages in general. I suggest doing the usual and stopping at line 10 above.
Resolves #164.
Updates the snap description. Uses the output from
chisel help --allinstead ofchisel --helpfor details.