Mirrors/miller
1
0
Fork 0
mirror of https://github.com/johnkerl/miller.git synced 2026-01-23 02:14:13 +00:00
Code Issues Projects Releases Wiki Activity

Add descriptions for put and filter verbs (#1529)

Browse source 
* Add more info in online help about what put/filter do

* `make dev` artifacts
This commit is contained in:
John Kerl 2024-03-16 17:09:01 -04:00 • committed by GitHub
parent f01bb92da7
commit 83c44e6d74
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 60 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/src/manpage.md
View file

@ -804,6 +804,7 @@ This is simply a copy of what you should see on running `man mlr` at a command p
csv "," N/A "\n"
csvlite "," N/A "\n"
dkvp "," "=" "\n"
gen "," N/A "\n"
json N/A N/A N/A
markdown " " N/A "\n"
nidx " " N/A "\n"
@ -1072,6 +1073,10 @@ This is simply a copy of what you should see on running `man mlr` at a command p
1mfilter0m
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -1525,6 +1530,9 @@ This is simply a copy of what you should see on running `man mlr` at a command p
1mput0m
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -3704,5 +3712,5 @@ This is simply a copy of what you should see on running `man mlr` at a command p
MIME Type for Comma-Separated Values (CSV) Files, the Miller docsite
https://miller.readthedocs.io
2024-02-18 4mMILLER24m(1)
2024-03-16 4mMILLER24m(1)
</pre>

10
docs/src/manpage.txt
View file

@ -783,6 +783,7 @@
csv "," N/A "\n"
csvlite "," N/A "\n"
dkvp "," "=" "\n"
gen "," N/A "\n"
json N/A N/A N/A
markdown " " N/A "\n"
nidx " " N/A "\n"
@ -1051,6 +1052,10 @@
1mfilter0m
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -1504,6 +1509,9 @@
1mput0m
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -3683,4 +3691,4 @@
MIME Type for Comma-Separated Values (CSV) Files, the Miller docsite
https://miller.readthedocs.io
2024-02-18 4mMILLER24m(1)
2024-03-16 4mMILLER24m(1)

1
docs/src/reference-main-flag-list.md
View file

@ -477,6 +477,7 @@ Notes about all other separators:
csv "," N/A "\n"
csvlite "," N/A "\n"
dkvp "," "=" "\n"
gen "," N/A "\n"
json N/A N/A N/A
markdown " " N/A "\n"
nidx " " N/A "\n"

7
docs/src/reference-verbs.md
View file

@ -970,6 +970,10 @@ a,b,c
</pre>
<pre class="pre-non-highlight-in-pair">
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -2301,6 +2305,9 @@ Options:
</pre>
<pre class="pre-non-highlight-in-pair">
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.

10
man/manpage.txt
View file

@ -783,6 +783,7 @@
csv "," N/A "\n"
csvlite "," N/A "\n"
dkvp "," "=" "\n"
gen "," N/A "\n"
json N/A N/A N/A
markdown " " N/A "\n"
nidx " " N/A "\n"
@ -1051,6 +1052,10 @@
1mfilter0m
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -1504,6 +1509,9 @@
1mput0m
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -3683,4 +3691,4 @@
MIME Type for Comma-Separated Values (CSV) Files, the Miller docsite
https://miller.readthedocs.io
2024-02-18 4mMILLER24m(1)
2024-03-16 4mMILLER24m(1)

12
man/mlr.1
View file

@ -2,12 +2,12 @@
.\" Title: mlr
.\" Author: [see the "AUTHOR" section]
.\" Generator: ./mkman.rb
.\" Date: 2024-02-18
.\" Date: 2024-03-16
.\" Manual: \ \&
.\" Source: \ \&
.\" Language: English
.\"
.TH "MILLER" "1" "2024-02-18" "\ \&" "\ \&"
.TH "MILLER" "1" "2024-03-16" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Portability definitions
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -936,6 +936,7 @@ Notes about all other separators:
csv "," N/A "\en"
csvlite "," N/A "\en"
dkvp "," "=" "\en"
gen "," N/A "\en"
json N/A N/A N/A
markdown " " N/A "\en"
nidx " " N/A "\en"
@ -1314,6 +1315,10 @@ Options:
.\}
.nf
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -1899,6 +1904,9 @@ Options:
.\}
.nf
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.

8
pkg/transformers/put_or_filter.go
View file

@ -52,6 +52,14 @@ func transformerPutOrFilterUsage(
verb string,
) {
fmt.Fprintf(o, "Usage: %s %s [options] {DSL expression}\n", "mlr", verb)
if verb == "put" {
fmt.Fprintf(o, "Lets you use a domain-specific language to progamatically alter stream records.\n")
} else if verb == "filter" {
fmt.Fprintf(o, "Lets you use a domain-specific language to progamatically filter which\n")
fmt.Fprintf(o, "stream records will be output.\n")
}
fmt.Fprintf(o, "See also: https://miller.readthedocs.io/en/latest/reference-verbs\n")
fmt.Fprintf(o, "\n")
fmt.Fprintf(o, "Options:\n")
fmt.Fprintf(o,
`-f {file name} File containing a DSL expression (see examples below). If the filename

7
test/cases/cli-help/0001/expout
View file

@ -186,6 +186,10 @@ Options:
================================================================
filter
Usage: mlr filter [options] {DSL expression}
Lets you use a domain-specific language to progamatically filter which
stream records will be output.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.
@ -661,6 +665,9 @@ Options:
================================================================
put
Usage: mlr put [options] {DSL expression}
Lets you use a domain-specific language to progamatically alter stream records.
See also: https://miller.readthedocs.io/en/latest/reference-verbs
Options:
-f {file name} File containing a DSL expression (see examples below). If the filename
is a directory, all *.mlr files in that directory are loaded.