fix: sentence-style usage strings (#713)

* fix: sentence-style usage strings

* docs: make gen-doc

Author: minhd-vu

cmd/dumpblocks/dumpblocks.go

@@ -193,7 +193,7 @@ func init() {
 	f.StringVarP(&inputDumpblocks.Filename, "filename", "f", "", "where to write the output to (default stdout)")
 	f.StringVarP(&inputDumpblocks.Mode, "mode", "m", "json", "the output format [json, proto]")
 	f.Uint64VarP(&inputDumpblocks.BatchSize, "batch-size", "b", 150, "batch size for requests (most providers cap at 1000)")
-	f.StringVarP(&inputDumpblocks.FilterStr, "filter", "F", "{}", "filter output based on tx to and from, not setting a filter means all are allowed")
+	f.StringVarP(&inputDumpblocks.FilterStr, "filter", "F", "{}", "filter output based on tx to and from (not setting a filter means all are allowed)")
 }
 
 func checkFlags() error {

cmd/p2p/sensor/sensor.go

@@ -430,15 +430,14 @@ func init() {
 	}
 	f.IntVarP(&inputSensorParams.MaxPeers, "max-peers", "m", 2000, "maximum number of peers to connect to")
 	f.IntVarP(&inputSensorParams.MaxDatabaseConcurrency, "max-db-concurrency", "D", 10000,
-		`maximum number of concurrent database operations to perform. Increasing this
-will result in less chance of missing data (i.e. broken pipes) but can
-significantly increase memory usage`)
+		`maximum number of concurrent database operations to perform (increasing this
+will result in less chance of missing data but can significantly increase memory usage)`)
 	f.BoolVarP(&inputSensorParams.ShouldWriteBlocks, "write-blocks", "B", true, "write blocks to database")
 	f.BoolVar(&inputSensorParams.ShouldWriteBlockEvents, "write-block-events", true, "write block events to database")
 	f.BoolVarP(&inputSensorParams.ShouldWriteTransactions, "write-txs", "t", true,
-		`write transactions to database. This option can significantly increase CPU and memory usage`)
+		`write transactions to database (this option can significantly increase CPU and memory usage)`)
 	f.BoolVar(&inputSensorParams.ShouldWriteTransactionEvents, "write-tx-events", true,
-		`write transaction events to database. This option can significantly increase CPU and memory usage`)
+		`write transaction events to database (this option can significantly increase CPU and memory usage)`)
 	f.BoolVar(&inputSensorParams.ShouldWritePeers, "write-peers", true, "write peers to database")
 	f.BoolVar(&inputSensorParams.ShouldRunPprof, "pprof", false, "run pprof server")
 	f.UintVar(&inputSensorParams.PprofPort, "pprof-port", 6060, "port pprof runs on")
@@ -455,8 +454,7 @@ significantly increase memory usage`)
 	f.StringVar(&inputSensorParams.GenesisHash, "genesis-hash", "0xa9c28ce2141b56c474f1dc504bee9b01eb1bd7d1a507580d5519d4437a97de1b", "genesis block hash")
 	f.BytesHexVar(&inputSensorParams.ForkID, "fork-id", []byte{240, 151, 188, 19}, "hex encoded fork ID (omit 0x)")
 	f.IntVar(&inputSensorParams.DialRatio, "dial-ratio", 0,
-		`ratio of inbound to dialed connections. A dial ratio of 2 allows 1/2 of
-connections to be dialed. Setting this to 0 defaults it to 3`)
+		`ratio of inbound to dialed connections (dial ratio of 2 allows 1/2 of connections to be dialed, setting to 0 defaults to 3)`)
 	f.StringVar(&inputSensorParams.NAT, "nat", "any", "NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>)")
 	f.StringVar(&inputSensorParams.StaticNodesFile, "static-nodes", "", "static nodes file")
 	f.StringVar(&inputSensorParams.TrustedNodesFile, "trusted-nodes", "", "trusted nodes file")

doc/polycli_dumpblocks.md

@@ -79,7 +79,7 @@ To solve this, add the unknown fields to the `.proto` files and recompile them (
   -B, --dump-blocks        dump blocks to output (default true)
       --dump-receipts      dump receipts to output (default true)
   -f, --filename string    where to write the output to (default stdout)
-  -F, --filter string      filter output based on tx to and from, not setting a filter means all are allowed (default "{}")
+  -F, --filter string      filter output based on tx to and from (not setting a filter means all are allowed) (default "{}")
   -h, --help               help for dumpblocks
   -m, --mode string        the output format [json, proto] (default "json")
   -r, --rpc-url string     the RPC endpoint URL (default "http://localhost:8545")

doc/polycli_p2p_sensor.md

@@ -30,18 +30,16 @@ If no nodes.json file exists, it will be created.
                                    - json (output to stdout)
                                    - none (no persistence) (default "none")
   -d, --database-id string       datastore database ID
-      --dial-ratio int           ratio of inbound to dialed connections. A dial ratio of 2 allows 1/2 of
-                                 connections to be dialed. Setting this to 0 defaults it to 3
+      --dial-ratio int           ratio of inbound to dialed connections (dial ratio of 2 allows 1/2 of connections to be dialed, setting to 0 defaults to 3)
       --discovery-dns string     DNS discovery ENR tree URL
       --discovery-port int       UDP P2P discovery port (default 30303)
       --fork-id bytesHex         hex encoded fork ID (omit 0x) (default F097BC13)
       --genesis-hash string      genesis block hash (default "0xa9c28ce2141b56c474f1dc504bee9b01eb1bd7d1a507580d5519d4437a97de1b")
   -h, --help                     help for sensor
       --key string               hex-encoded private key (cannot be set with --key-file)
   -k, --key-file string          private key file (cannot be set with --key)
-  -D, --max-db-concurrency int   maximum number of concurrent database operations to perform. Increasing this
-                                 will result in less chance of missing data (i.e. broken pipes) but can
-                                 significantly increase memory usage (default 10000)
+  -D, --max-db-concurrency int   maximum number of concurrent database operations to perform (increasing this
+                                 will result in less chance of missing data but can significantly increase memory usage) (default 10000)
   -m, --max-peers int            maximum number of peers to connect to (default 2000)
       --nat string               NAT port mapping mechanism (any|none|upnp|pmp|pmp:<IP>|extip:<IP>) (default "any")
   -n, --network-id uint          filter discovered nodes by this network ID
@@ -61,8 +59,8 @@ If no nodes.json file exists, it will be created.
       --write-block-events       write block events to database (default true)
   -B, --write-blocks             write blocks to database (default true)
       --write-peers              write peers to database (default true)
-      --write-tx-events          write transaction events to database. This option can significantly increase CPU and memory usage (default true)
-  -t, --write-txs                write transactions to database. This option can significantly increase CPU and memory usage (default true)
+      --write-tx-events          write transaction events to database (this option can significantly increase CPU and memory usage) (default true)
+  -t, --write-txs                write transactions to database (this option can significantly increase CPU and memory usage) (default true)
 ```
 
 The command also inherits flags from parent commands.