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

Standardize CLI documentation #153

Open
brennanjl opened this issue Sep 25, 2024 · 0 comments
Open

Standardize CLI documentation #153

brennanjl opened this issue Sep 25, 2024 · 0 comments

Comments

@brennanjl
Copy link
Contributor

Our CLI documentation documents arguments and flags as follows:

cli command --flag <flag_arg> <other_arg>

This originated with me a long time ago, and is now used everywhere except for the kwil-admin docs. However, it seems there is a loose standard for documenting command lines (a good explanation can be found here). We should update our docs to use this.

This is not a release blocker for v0.9

@brennanjl brennanjl mentioned this issue Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant