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.

Sign up for GitHub

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

Jump to bottom

Improve CLI command help instructions #118

Closed
agraebe opened this issue Sep 15, 2021 · 2 comments
Closed

Improve CLI command help instructions #118

agraebe opened this issue Sep 15, 2021 · 2 comments
Assignees
@lgalabru

Comments

@agraebe
Copy link

agraebe commented Sep 15, 2021

The current help is fairly basic and could benefit from a revision. This file is most relevant:

clarinet/src/frontend/cli.rs

Line 29 in 21b91e5

enum Command {

@pgray-hiro do you think we could jam on the instructions we would like to see here?
@pgray-hiro
Copy link
Contributor

At the minimum I think each command and subcommand needs an .about string with clap and each arg needs a .help string. I would jump in and try to help but I don't know Rust well enough, and this code is different enough from the publicly available clap examples that I can't figure out where to put these strings.

@lgalabru could you show an example of how to insert these help strings into your code?

@lgalabru lgalabru self-assigned this Sep 28, 2021
obycode added a commit that referenced this issue Feb 23, 2022
@obycode
feat: clean up commands and improve help docs
07b7c83 
Resolves #118
obycode added a commit that referenced this issue Feb 23, 2022
@obycode
feat: clean up commands and improve help docs
4672242 
Resolves #118
obycode added a commit that referenced this issue Feb 24, 2022
@obycode
feat: clean up commands and improve help docs
8f18182 
Resolves #118
blockstack-devops pushed a commit that referenced this issue Feb 24, 2022
@semantic-release-bot
chore(release): 0.27.0
a70c758 
# [0.27.0](v0.26.1...v0.27.0) (2022-02-24)

### Features

* add shell completions files ([e6b1f25](e6b1f25))
* add subcommand to generate shell completions ([a493b67](a493b67)), closes [#146](#146)
* clean up commands and improve help docs ([8f18182](8f18182)), closes [#118](#118)
* stacks-devnet-js support for linux-musl (non-glibc, e.g. alpine) ([6e322f1](6e322f1))
@blockstack-devops
Copy link
Collaborator

🎉 This issue has been resolved in version 0.27.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lgalabru lgalabru

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@lgalabru @agraebe @blockstack-devops @pgray-hiro