Work around bug in docsgencli by using one-liner usage

filecoin-project · Nov 19, 2024 · cb52aa9 · cb52aa9
1 parent 65c673e
commit cb52aa9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 29 deletions.
diff --git a/cli/f3.go b/cli/f3.go
@@ -85,12 +85,9 @@ var f3SubCmdPowerTable = &cli.Command{
 	Aliases: []string{"pt"},
 	Subcommands: []*cli.Command{
 		{
-			Name:    "get",
-			Aliases: []string{"g"},
-			Usage: `Get F3 power table at a specific instance ID or latest instance if none is specified.
-
-The instance may be specified as the first argument. If unspecified,
-the latest instance is used.`,
+			Name:      "get",
+			Aliases:   []string{"g"},
+			Usage:     `Get F3 power table at a specific instance ID or latest instance if none is specified.`,
 			ArgsUsage: "[instance]",
 			Flags:     []cli.Flag{f3FlagPowerTableFromEC},
 			Before: func(cctx *cli.Context) error {
@@ -179,16 +176,9 @@ the latest instance is used.`,
 			},
 		},
 		{
-			Name:    "get-proportion",
-			Aliases: []string{"gp"},
-			Usage: `Gets the total proportion of power for a list of actors at a given instance.
-
-The instance may be specified via --instance flag. If unspecified, the
-latest instance is used.
-
-The list of actors may be specified as Actor ID or miner address, space
-separated, via arguments. Example:
-  $ lotus f3 powertable get-proportion -i 42 1413 t01234 f12345`,
+			Name:      "get-proportion",
+			Aliases:   []string{"gp"},
+			Usage:     `Gets the total proportion of power for a list of actors at a given instance.`,
 			ArgsUsage: "<actor-id> [actor-id] ...",
 			Flags: []cli.Flag{
 				f3FlagPowerTableFromEC,

diff --git a/documentation/en/cli-lotus.md b/documentation/en/cli-lotus.md
@@ -2831,17 +2831,7 @@ USAGE:
 
 COMMANDS:
    get, g              Get F3 power table at a specific instance ID or latest instance if none is specified.
-
-                       The instance may be specified as the first argument. If unspecified,
-                       the latest instance is used.
    get-proportion, gp  Gets the total proportion of power for a list of actors at a given instance.
-
-                       The instance may be specified via --instance flag. If unspecified, the
-                       latest instance is used.
-
-                       The list of actors may be specified as Actor ID or miner address, space
-                       separated, via arguments. Example:
-                         $ lotus f3 powertable get-proportion -i 42 1413 t01234 f12345
    help, h             Shows a list of commands or help for one command
 
 OPTIONS:
@@ -2853,9 +2843,6 @@ OPTIONS:
 NAME:
    lotus f3 powertable get - Get F3 power table at a specific instance ID or latest instance if none is specified.
 
-                             The instance may be specified as the first argument. If unspecified,
-                             the latest instance is used.
-
 USAGE:
    lotus f3 powertable get [command options] [instance]
 
@@ -2864,6 +2851,20 @@ OPTIONS:
    --help, -h  show help
 ```
 
+#### lotus f3 powertable get-proportion
+```
+NAME:
+   lotus f3 powertable get-proportion - Gets the total proportion of power for a list of actors at a given instance.
+
+USAGE:
+   lotus f3 powertable get-proportion [command options] <actor-id> [actor-id] ...
+
+OPTIONS:
+   --ec                        Whether to get the power table from EC. (default: false)
+   --instance value, -i value  The F3 instance ID. (default: Latest Instance)
+   --help, -h                  show help
+```
+
 ### lotus f3 certs
 ```
 NAME: