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

Provide examples to each major in-toto cli subcommand #152

Open
shibumi opened this issue Oct 17, 2021 · 3 comments
Open

Provide examples to each major in-toto cli subcommand #152

shibumi opened this issue Oct 17, 2021 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@shibumi
Copy link
Collaborator

shibumi commented Oct 17, 2021

According to the Cobra documentation, Cobra supports examples. I think we should use these example strings for making in-toto easier to use. This might be something for @alanssitis. Do you want to have a look? :)

@alanssitis
Copy link
Member

@shibumi could you link the documentation you are referring to? I do not understand what you mean by example strings.

@developer-guy
Copy link
Contributor

hello @alanssitis, IMHO, @shibumi refers to the command's long description, you can use this field to add examples of using this command. For example, you can look at the example of the completion command.

👀 https://github.com/in-toto/in-toto-golang/blob/master/cmd/completion.go#L18

@alanssitis
Copy link
Member

alanssitis commented Oct 19, 2021

Yeah @shibumi , I can definitely take a look into it! Thank you @developer-guy for pointing me to the right direction 😄!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

3 participants