Small typos in documentation of mlr nest (#1352)

* Typofix in `nest` documentation * update test/cases/cli-help * artifacts from `make dev`
johnkerl · Aug 9, 2023 · 52db2bf · 52db2bf
1 parent fcd201d
commit 52db2bf
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 19 deletions.
diff --git a/docs/src/manpage.md b/docs/src/manpage.md
@@ -1442,8 +1442,8 @@ MILLER(1)                                                            MILLER(1)
          -f {field name}       Required.
          --nested-fs {string}  Defaults to ";". Field separator for nested values.
          --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-         --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-         --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+         --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+         --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
        Please use "mlr --usage-separator-options" for information on specifying separators.
 
        Examples:
@@ -3434,5 +3434,5 @@ MILLER(1)                                                            MILLER(1)
 
 
 
-                                  2023-07-04                         MILLER(1)
+                                  2023-08-09                         MILLER(1)
 </pre>
diff --git a/docs/src/manpage.txt b/docs/src/manpage.txt
@@ -1421,8 +1421,8 @@ MILLER(1)                                                            MILLER(1)
          -f {field name}       Required.
          --nested-fs {string}  Defaults to ";". Field separator for nested values.
          --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-         --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-         --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+         --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+         --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
        Please use "mlr --usage-separator-options" for information on specifying separators.
 
        Examples:
@@ -3413,4 +3413,4 @@ MILLER(1)                                                            MILLER(1)
 
 
 
-                                  2023-07-04                         MILLER(1)
+                                  2023-08-09                         MILLER(1)
diff --git a/docs/src/reference-verbs.md b/docs/src/reference-verbs.md
@@ -2188,8 +2188,8 @@ Options:
   -f {field name}       Required.
   --nested-fs {string}  Defaults to ";". Field separator for nested values.
   --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-  --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-  --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+  --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+  --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
 Please use "mlr --usage-separator-options" for information on specifying separators.
 
 Examples:

diff --git a/internal/pkg/transformers/nest.go b/internal/pkg/transformers/nest.go
@@ -40,8 +40,8 @@ func transformerNestUsage(
 	fmt.Fprintf(o, "  -f {field name}       Required.\n")
 	fmt.Fprintf(o, "  --nested-fs {string}  Defaults to \";\". Field separator for nested values.\n")
 	fmt.Fprintf(o, "  --nested-ps {string}  Defaults to \":\". Pair separator for nested key-value pairs.\n")
-	fmt.Fprintf(o, "  --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}\n")
-	fmt.Fprintf(o, "  --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}\n")
+	fmt.Fprintf(o, "  --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}\n")
+	fmt.Fprintf(o, "  --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}\n")
 	fmt.Fprintf(o, "Please use \"%s --usage-separator-options\" for information on specifying separators.\n",
 		argv0)
 

diff --git a/man/manpage.txt b/man/manpage.txt
@@ -1421,8 +1421,8 @@ MILLER(1)                                                            MILLER(1)
          -f {field name}       Required.
          --nested-fs {string}  Defaults to ";". Field separator for nested values.
          --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-         --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-         --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+         --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+         --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
        Please use "mlr --usage-separator-options" for information on specifying separators.
 
        Examples:
@@ -3413,4 +3413,4 @@ MILLER(1)                                                            MILLER(1)
 
 
 
-                                  2023-07-04                         MILLER(1)
+                                  2023-08-09                         MILLER(1)
diff --git a/man/mlr.1 b/man/mlr.1
@@ -2,12 +2,12 @@
 .\"     Title: mlr
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: ./mkman.rb
-.\"      Date: 2023-07-04
+.\"      Date: 2023-08-09
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "MILLER" "1" "2023-07-04" "\ \&" "\ \&"
+.TH "MILLER" "1" "2023-08-09" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Portability definitions
 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1796,8 +1796,8 @@ Options:
   -f {field name}       Required.
   --nested-fs {string}  Defaults to ";". Field separator for nested values.
   --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-  --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-  --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+  --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+  --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
 Please use "mlr --usage-separator-options" for information on specifying separators.
 
 Examples:

diff --git a/test/cases/cli-help/0001/expout b/test/cases/cli-help/0001/expout
@@ -597,8 +597,8 @@ Options:
   -f {field name}       Required.
   --nested-fs {string}  Defaults to ";". Field separator for nested values.
   --nested-ps {string}  Defaults to ":". Pair separator for nested key-value pairs.
-  --evar {string}       Shorthand for --explode --values ---across-records --nested-fs {string}
-  --ivar {string}       Shorthand for --implode --values ---across-records --nested-fs {string}
+  --evar {string}       Shorthand for --explode --values --across-records --nested-fs {string}
+  --ivar {string}       Shorthand for --implode --values --across-records --nested-fs {string}
 Please use "mlr --usage-separator-options" for information on specifying separators.
 
 Examples: