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

Add examples for every command in docs #2015

Open
piotmag769 opened this issue May 29, 2023 · 0 comments
Open

Add examples for every command in docs #2015

piotmag769 opened this issue May 29, 2023 · 0 comments
Labels
good first issue Good for newcomers

Comments

@piotmag769
Copy link
Contributor

Currently some of our commands don't have example usages, some of them do.
We should make it consistent.

https://docs.swmansion.com/protostar/docs/cli-reference

To add an example just create a function in a class implementing a command

@property
def example(self) -> Optional[str]:
    return "protostar deploy 0x4221deadbeef123 --network testnet"
@piotmag769 piotmag769 changed the title Add examples for every command Add examples for every command in docs May 29, 2023
@piotmag769 piotmag769 added the good first issue Good for newcomers label Jun 1, 2023
@piotmag769 piotmag769 added this to the Documentation improvements milestone Jun 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants