Skip to content

Standardize CLI documentation #153

@brennanjl

Description

@brennanjl

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions