feat: improve command description and example

axone-protocol · Jan 11, 2023 · 2be2ee8 · 2be2ee8
1 parent c48870f
commit 2be2ee8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/docs/command/okp4d_query_logic_ask.md b/docs/command/okp4d_query_logic_ask.md
@@ -4,7 +4,9 @@ executes a logic query and returns the solutions found.
 
 ### Synopsis
 
-Executes the [query] for the given [program] file and return the solution(s) found.
+Executes the [query] and return the solution(s) found.
+
+Optionally, a program can be transmitted, which will be interpreted before the query is processed.
 
 Since the query is without any side-effect, the query is not executed in the context of a transaction and no fee
 is charged for this, but the execution is constrained by the current limits configured in the module (that you can
@@ -17,7 +19,7 @@ okp4d query logic ask [query] [flags]
 ### Examples
 
 ```
-okp4d logic query ask "chain_id(X)." # returns the chain-id
+okp4d query logic ask "chain_id(X)." # returns the chain-id
 ```
 
 ### Options

diff --git a/x/logic/client/cli/query_ask.go b/x/logic/client/cli/query_ask.go
@@ -22,12 +22,14 @@ func CmdQueryAsk() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "ask [query]",
 		Short: "executes a logic query and returns the solutions found.",
-		Long: `Executes the [query] for the given [program] file and return the solution(s) found.
+		Long: `Executes the [query] and return the solution(s) found.
+
+Optionally, a program can be transmitted, which will be interpreted before the query is processed.
 
 Since the query is without any side-effect, the query is not executed in the context of a transaction and no fee
 is charged for this, but the execution is constrained by the current limits configured in the module (that you can
 query).`,
-		Example: fmt.Sprintf(`$ %s %s query ask "chain_id(X)." # returns the chain-id`,
+		Example: fmt.Sprintf(`$ %s query %s ask "chain_id(X)." # returns the chain-id`,
 			version.AppName,
 			types.ModuleName),
 		Args: cobra.MinimumNArgs(1),