Skip to content

Support documentation for strict = false command arguments #234

@mattgibson

Description

@mattgibson

Do you want to request a feature or report a bug?

Feature.

What is the current behavior?

If I specify strict = false and use argv to access whatever variable length string of arguments the user provides, there is no way to document this. The README doesn't mention that there is an arbitrary list of arguments accepted and if I specify this manually by editing the command form e.g.

USAGE
  $ fd start [SERVICES...]

ARGUMENTS
  SERVICES...  a list of service names

Then it gets overwriten next time I run npx oclif command to add a new one.

What is the expected behavior?

(@oclif/command@1.5.13 on macOS) That I can add documentation similar to that for flags with multiple arguments, which will show up in the README and when using the --help flag.

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