Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention -n in IO-section and for input/inputs #2395

Merged
merged 1 commit into from
May 26, 2022
Merged

Mention -n in IO-section and for input/inputs #2395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/content/manual/manual.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2924,7 +2924,9 @@ sections:
are provided for this, `input` and `inputs`, that read from the
same sources (e.g., `stdin`, files named on the command-line) as
jq itself. These two builtins, and jq's own reading actions, can
be interleaved with each other.
be interleaved with each other. They are commonly used in combination
with the null input option `-n` to prevent one input from being read
implicitly.

Two builtins provide minimal output capabilities, `debug`, and
`stderr`. (Recall that a jq program's output values are always
Expand All @@ -2944,13 +2946,19 @@ sections:

Outputs one new input.

Note that when using `input` it is generally be necessary to
invoke jq with the -n command-line option, otherwise
the first entity will be lost.

- title: "`inputs`"
body: |

Outputs all remaining inputs, one by one.

This is primarily useful for reductions over a program's
inputs.
inputs. Note that when using `inputs` it is generally necessary
to invoke jq with the -n command-line option, otherwise
the first entity will be lost.

- title: "`debug`"
body: |
Expand Down