Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

snap: update description #165

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rebornplusplus
Copy link
Member

Resolves #164.

Updates the snap description. Uses the output from chisel help --all instead of chisel --help for details.

version Show version details

Action (make things happen):
cut Cut a tree with selected slices

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cut Cut a tree with selected slices
cut Cut a package with selected slices

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK "cut a tree with selected slices" is what is currently printed when you run chisel help --all.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, it's copied from the help. :)

@cjdcordeiro cjdcordeiro added the Simple Nice for a quick look on a minute or two label Oct 17, 2024
Copy link
Collaborator

@letFunny letFunny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@linostar linostar self-requested a review October 23, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Simple Nice for a quick look on a minute or two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: update Chisel snap description
4 participants