docs: explain that semicolons separate function arguments (#3685)
The manual's "Defining Functions" section shows only one-argument functions, so it never says how to pass more than one. This adds a short paragraph: arguments are separated by `;` in both `def f(a; b):` and `f(.x; .y)`, and `f(.x, .y)` instead calls a one-argument `f` with the filter `.x, .y`. It also adds an example for each. `tests/man.test` and `jq.1.prebuilt` are regenerated. Fixes #2163
This commit is contained in:
1 parent
e440cccc0a
commit
49fbca1242
3 files changed
+49
No files matched your search
@@ -3072,6 +3072,16 @@ sections:
|
||||
to be evaluated once per value in the value of `.` at the call
|
||||
site.
|
||||
|
||||
Multiple arguments are separated by semicolons, both in the
|
||||
definition and in the call:
|
||||
|
||||
def f(a; b): ...;
|
||||
f(.x; .y)
|
||||
|
||||
A comma does not separate arguments. `f(.x, .y)` calls a
|
||||
one-argument `f` with the single filter `.x, .y`, which
|
||||
outputs `.x` and then `.y` (see the comma operator above).
|
||||
|
||||
Multiple definitions using the same function name are allowed.
|
||||
Each re-definition replaces the previous one for the same
|
||||
number of function arguments, but only for references from
|
||||
@@ -3085,6 +3095,12 @@ sections:
|
||||
- program: 'def addvalue(f): f as $x | map(. + $x); addvalue(.[0])'
|
||||
input: '[[1,2],[10,20]]'
|
||||
output: ['[[1,2,1,2], [10,20,1,2]]']
|
||||
- program: 'def f(a; b): [a, b]; f(.x; .y)'
|
||||
input: '{"x":1,"y":2}'
|
||||
output: ['[1,2]']
|
||||
- program: 'def f(a): [a]; f(.x, .y)'
|
||||
input: '{"x":1,"y":2}'
|
||||
output: ['[1,2]']
|
||||
|
||||
- title: 'Scoping'
|
||||
body: |
|
||||
|
||||
Reference in new issue
Block a user