From 81d7f3756fad6e4dbe550903927158ee5b2cbcaa Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:20:01 -0500 Subject: [PATCH 1/9] instead of using plurals in parentheses, lets follow the Google developer documentation style guide advice here "one or more" https://developers.google.com/style/plurals-parentheses --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 61ec84bdc219..769500b3caf6 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -32,8 +32,8 @@ func GetMultiSignCommand() *cobra.Command { Long: strings.TrimSpace( fmt.Sprintf(`Sign transactions created with the --generate-only flag that require multisig signatures. -Read signature(s) from [signature] file(s), generate a multisig signature compliant to the -multisig key [name], and attach it to the transaction read from [file]. +Read one or more signatures from one or more [signature] file, generate a multisig signature compliant to the +multisig key [name], and attach the key name to the transaction read from [file]. Example: $ %s tx multisign transaction.json k1k2k3 k1sig.json k2sig.json k3sig.json From edcfb06753b9bf475eecdcd4316d76f3880438db Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:27:48 -0500 Subject: [PATCH 2/9] Hi Sahith, I suggest we use imperative language and current tense per standards, and move only for clarity --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 769500b3caf6..179411810d71 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -38,8 +38,8 @@ multisig key [name], and attach the key name to the transaction read from [file] Example: $ %s tx multisign transaction.json k1k2k3 k1sig.json k2sig.json k3sig.json -If the flag --signature-only flag is on, it outputs a JSON representation -of the generated signature only. +If --signature-only flag is on, output a JSON representation +of only the generated signature. The --offline flag makes sure that the client will not reach out to an external node. Thus account number or sequence number lookups will not be performed and it is From 84a307484470dee38d87342e32cabc915cd86d94 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:28:20 -0500 Subject: [PATCH 3/9] r/w for clarity and imperative language present tense --- x/auth/client/cli/tx_multisign.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 179411810d71..e8765ae2cad9 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -41,9 +41,9 @@ $ %s tx multisign transaction.json k1k2k3 k1sig.json k2sig.json k3sig.json If --signature-only flag is on, output a JSON representation of only the generated signature. -The --offline flag makes sure that the client will not reach out to an external node. -Thus account number or sequence number lookups will not be performed and it is -recommended to set such parameters manually. +If the --offline flag is on, the client will not reach out to an external node. +Account number or sequence number lookups are not performed so you must +set these parameters manually. The current multisig implementation doesn't support SIGN_MORE_DIRECT and defaults to amino-json sign mode.' From 5140324e0d07e9e693af9b351604ed78a508439d Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:29:26 -0500 Subject: [PATCH 4/9] I recommend we state what IS supported before we list what is not supported since the unsupported list is incomplete by definition --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index e8765ae2cad9..978edd830c92 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -45,8 +45,8 @@ If the --offline flag is on, the client will not reach out to an external node. Account number or sequence number lookups are not performed so you must set these parameters manually. -The current multisig implementation doesn't support SIGN_MORE_DIRECT and defaults -to amino-json sign mode.' +The current multisig implementation defaults to amino-json sign mode. +The SIGN_MORE_DIRECT sign mode is not supported.' `, version.AppName, ), From f31ee2c1b97fcdc68731d8e7ee7bfbb762b33f90 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:31:28 -0500 Subject: [PATCH 5/9] let's use present tense here, and typo fix for submitting --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 978edd830c92..8185a5ad9b08 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -56,8 +56,8 @@ The SIGN_MORE_DIRECT sign mode is not supported.' } cmd.Flags().Bool(flagSigOnly, false, "Print only the generated signature, then exit") - cmd.Flags().String(flags.FlagOutputDocument, "", "The document will be written to the given file instead of STDOUT") - cmd.Flags().Bool(flagAmino, false, "Generate Amino encoded JSON suitable for submiting to the txs REST endpoint") + cmd.Flags().String(flags.FlagOutputDocument, "", "The document is written to the given file instead of STDOUT") + cmd.Flags().Bool(flagAmino, false, "Generate Amino-encoded JSON suitable for submitting to the txs REST endpoint") flags.AddTxFlagsToCmd(cmd) cmd.Flags().String(flags.FlagChainID, "", "network chain ID") From c966d0654583c84faad3760ad694decc5546c7c2 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:35:12 -0500 Subject: [PATCH 6/9] based on line 206, I think we mean SIGN_MODE_DIRECT not SIGN_MORE_DIRECT --- x/auth/client/cli/tx_multisign.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 8185a5ad9b08..14fcbcbfe623 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -46,7 +46,7 @@ Account number or sequence number lookups are not performed so you must set these parameters manually. The current multisig implementation defaults to amino-json sign mode. -The SIGN_MORE_DIRECT sign mode is not supported.' +The SIGN_MODE_DIRECT sign mode is not supported.' `, version.AppName, ), From eaa52e258168ebffa2b370fd6c74956c4c117ee1 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:35:44 -0500 Subject: [PATCH 7/9] same comment as the first instance of this text --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 14fcbcbfe623..5cf6811f60c4 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -196,8 +196,8 @@ func GetMultiSignBatchCmd() *cobra.Command { Long: strings.TrimSpace( fmt.Sprintf(`Assemble a batch of multisig transactions generated by batch sign command. -Read signature(s) from [signature] file(s), generates multisig signatures compliant to the -multisig key [name], and attach it to the transactions read from [file]. +Read one or more signatures from one or more [signature] file, generate a multisig signature compliant to the +multisig key [name], and attach the key name to the transaction read from [file]. Example: $ %s tx multisign-batch transactions.json multisigk1k2k3 k1sigs.json k2sigs.json k3sig.json From 971ff6d46492a0a9a6fff304ffbd20ccf41b4024 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:36:47 -0500 Subject: [PATCH 8/9] same edits as the first instance around line 35ish --- x/auth/client/cli/tx_multisign.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 5cf6811f60c4..7e21cb048138 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -202,8 +202,8 @@ multisig key [name], and attach the key name to the transaction read from [file] Example: $ %s tx multisign-batch transactions.json multisigk1k2k3 k1sigs.json k2sigs.json k3sig.json -The current multisig implementation doesn't support sign_mode_direct and defaults -to amino-json sign mode.' +The current multisig implementation defaults to amino-json sign mode. +The SIGN_MODE_DIRECT sign mode is not supported.' `, version.AppName, ), ), From 1a961a2b2c1cff4fd604d2d4c0397170114f4eb0 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Fri, 26 Feb 2021 09:45:19 -0500 Subject: [PATCH 9/9] I might not have this rewording exactly correct, but can we write in the active voice and specify who or what performed the action --- x/auth/client/cli/tx_multisign.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/x/auth/client/cli/tx_multisign.go b/x/auth/client/cli/tx_multisign.go index 7e21cb048138..c04d37123c2f 100644 --- a/x/auth/client/cli/tx_multisign.go +++ b/x/auth/client/cli/tx_multisign.go @@ -215,7 +215,7 @@ The SIGN_MODE_DIRECT sign mode is not supported.' cmd.Flags().Bool(flagNoAutoIncrement, false, "disable sequence auto increment") cmd.Flags().String( flagMultisig, "", - "Address of the multisig account on behalf of which the transaction shall be signed", + "Address of the multisig account that the transaction signs on behalf of", ) flags.AddTxFlagsToCmd(cmd)