Fix help documents

nihei9 · Apr 2, 2022 · 180cac3 · 180cac3
1 parent 0636432
commit 180cac3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/cmd/vartan/compile.go b/cmd/vartan/compile.go
@@ -23,7 +23,7 @@ var compileFlags = struct {
 func init() {
 	cmd := &cobra.Command{
 		Use:     "compile",
-		Short:   "Compile a grammar into a parsing table",
+		Short:   "Compile grammar you defined into a parsing table",
 		Example: `  vartan compile grammar.vr -o grammar.json`,
 		Args:    cobra.MaximumNArgs(1),
 		RunE:    runCompile,

diff --git a/cmd/vartan/root.go b/cmd/vartan/root.go
@@ -6,11 +6,10 @@ import (
 
 var rootCmd = &cobra.Command{
 	Use:   "vartan",
-	Short: "Generate a portable parsing table from a grammar",
+	Short: "Generate a portable LALR(1) parsing table from grammar you defined",
 	Long: `vartan provides two features:
-- Generates a portable parsing table from a grammar.
-- Tokenizes a text stream according to the grammar.
-  This feature is primarily aimed at debugging the grammar.`,
+- Generate a portable LALR(1) parsing table from grammar you defined.
+- Parse a text stream according to the grammar.`,
 	SilenceErrors: true,
 	SilenceUsage:  true,
 }