Skip to content

[Question] Help Documentation for "optional" options. #144

@Simonl9l

Description

@Simonl9l

It seem that to have an "optional" option it must have a default value assigned to parameter in the commands method signature. Otherwise the --help indicates them as (Required) Isn't a Required option more an Argument?

This mean that for any command any "optional" options all have to be at the end of the signature, whilst this is feasible, the --help is perhaps too technical - exposing facets of the underlying implementation.

Whist a string parameter could be nullable - string? param1 = null this results in the --help saying (Default: null) - which is kinda technical, and if alternatively one defines the parameter as string param1 = "" results in the --help saying (Default: "").

Additionally the option type if nullable are used is defined as --param <string?> tha tis also a tad technical.

If there was a way to say it's optional say, in part of the /// <param....></param> the help could just say (Optional) - or nothing (as it's already described as being part of Options:)?

An option is possibly required, dependent on the presence of other options, but this is also not configurable?

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