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.

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

[Docs] Clarify the behvior of first, last, and nth on empty generators #3177

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/content/manual/v1.7/manual.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3004,10 +3004,17 @@ sections:
The `nth(n; expr)` function extracts the nth value output by `expr`.
Note that `nth(n; expr)` doesn't support negative values of `n`.

`first` and `nth` produce no values if the generator has insufficient
elements. `last` currently returns `null` instead. `last` might be
modified to produce no values in the future.

examples:
- program: "[first(range(.)), last(range(.)), nth(./2; range(.))]"
input: "10"
output: ["[0,9,5]"]
- program: "[[first(range(.))], [last(range(.))], [nth(5; range(.))]]"
input: "0"
output: ["[[],[null],[]]"]

- title: "`first`, `last`, `nth(n)`"
body: |
Expand Down
Loading