From 202a79d0e24e7364e092a1cb293d03ef4633c9e1 Mon Sep 17 00:00:00 2001 From: John Kerl Date: Sat, 8 Jun 2024 13:37:07 -0400 Subject: [PATCH] On-line help for `mlr summary --transpose` (#1581) * On-line help for `mlr summary --transpose` * run `make dev` --- docs/src/manpage.md | 1 + docs/src/manpage.txt | 1 + docs/src/reference-verbs.md | 1 + man/manpage.txt | 1 + man/mlr.1 | 1 + pkg/transformers/summary.go | 1 + test/cases/cli-help/0001/expout | 1 + 7 files changed, 7 insertions(+) diff --git a/docs/src/manpage.md b/docs/src/manpage.md index db104861d..a7929a937 100644 --- a/docs/src/manpage.md +++ b/docs/src/manpage.md @@ -2099,6 +2099,7 @@ This is simply a copy of what you should see on running `man mlr` at a command p -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. + --transpose Show output with field names as column names.. -h|--help Show this message. 1mtac0m diff --git a/docs/src/manpage.txt b/docs/src/manpage.txt index 4ff577844..4975b7646 100644 --- a/docs/src/manpage.txt +++ b/docs/src/manpage.txt @@ -2078,6 +2078,7 @@ -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. + --transpose Show output with field names as column names.. -h|--help Show this message. 1mtac0m diff --git a/docs/src/reference-verbs.md b/docs/src/reference-verbs.md index a90f0890f..8105820c5 100644 --- a/docs/src/reference-verbs.md +++ b/docs/src/reference-verbs.md @@ -3796,6 +3796,7 @@ Options: -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. +--transpose Show output with field names as column names.. -h|--help Show this message. diff --git a/man/manpage.txt b/man/manpage.txt index 4ff577844..4975b7646 100644 --- a/man/manpage.txt +++ b/man/manpage.txt @@ -2078,6 +2078,7 @@ -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. + --transpose Show output with field names as column names.. -h|--help Show this message. 1mtac0m diff --git a/man/mlr.1 b/man/mlr.1 index c39347089..a123eaf20 100644 --- a/man/mlr.1 +++ b/man/mlr.1 @@ -2605,6 +2605,7 @@ Options: -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. +--transpose Show output with field names as column names.. -h|--help Show this message. .fi .if n \{\ diff --git a/pkg/transformers/summary.go b/pkg/transformers/summary.go index 56d95b2d4..ea5f123bc 100644 --- a/pkg/transformers/summary.go +++ b/pkg/transformers/summary.go @@ -106,6 +106,7 @@ func transformerSummaryUsage( fmt.Fprintf(o, "-a {mean,sum,etc.} Use only the specified summarizers.\n") fmt.Fprintf(o, "-x {mean,sum,etc.} Use all summarizers, except the specified ones.\n") fmt.Fprintf(o, "--all Use all available summarizers.\n") + fmt.Fprintf(o, "--transpose Show output with field names as column names..\n") fmt.Fprintf(o, "-h|--help Show this message.\n") } diff --git a/test/cases/cli-help/0001/expout b/test/cases/cli-help/0001/expout index 6d6cdea85..e6ed5ea33 100644 --- a/test/cases/cli-help/0001/expout +++ b/test/cases/cli-help/0001/expout @@ -1252,6 +1252,7 @@ Options: -a {mean,sum,etc.} Use only the specified summarizers. -x {mean,sum,etc.} Use all summarizers, except the specified ones. --all Use all available summarizers. +--transpose Show output with field names as column names.. -h|--help Show this message. ================================================================