mirror of
https://github.com/ipfs/kubo.git
synced 2025-06-19 18:05:32 +08:00
commands: Added 'Description' fields to Command, Argument, Option
This commit is contained in:

committed by
Juan Batiz-Benet

parent
538dac153b
commit
351ed9589a
@ -12,4 +12,5 @@ type Argument struct {
|
|||||||
Type ArgumentType
|
Type ArgumentType
|
||||||
Required bool
|
Required bool
|
||||||
Variadic bool
|
Variadic bool
|
||||||
|
Description string
|
||||||
}
|
}
|
||||||
|
@ -28,7 +28,9 @@ type Marshaller func(Response) ([]byte, error)
|
|||||||
// Command is a runnable command, with input arguments and options (flags).
|
// Command is a runnable command, with input arguments and options (flags).
|
||||||
// It can also have Subcommands, to group units of work into sets.
|
// It can also have Subcommands, to group units of work into sets.
|
||||||
type Command struct {
|
type Command struct {
|
||||||
|
Description string
|
||||||
Help string
|
Help string
|
||||||
|
|
||||||
Options []Option
|
Options []Option
|
||||||
Arguments []Argument
|
Arguments []Argument
|
||||||
Run Function
|
Run Function
|
||||||
|
@ -16,6 +16,7 @@ const (
|
|||||||
type Option struct {
|
type Option struct {
|
||||||
Names []string // a list of unique names to
|
Names []string // a list of unique names to
|
||||||
Type reflect.Kind // value must be this type
|
Type reflect.Kind // value must be this type
|
||||||
|
Description string // a short string to describe this option
|
||||||
|
|
||||||
// TODO: add more features(?):
|
// TODO: add more features(?):
|
||||||
//Default interface{} // the default value (ignored if `Required` is true)
|
//Default interface{} // the default value (ignored if `Required` is true)
|
||||||
@ -30,7 +31,8 @@ const (
|
|||||||
|
|
||||||
// options that are used by this package
|
// options that are used by this package
|
||||||
var globalOptions = []Option{
|
var globalOptions = []Option{
|
||||||
Option{[]string{EncShort, EncLong}, String},
|
Option{[]string{EncShort, EncLong}, String,
|
||||||
|
"The encoding type the output should be encoded with (json, xml, or text)"},
|
||||||
}
|
}
|
||||||
|
|
||||||
// the above array of Options, wrapped in a Command
|
// the above array of Options, wrapped in a Command
|
||||||
|
Reference in New Issue
Block a user