mirror of
https://github.com/nushell/nushell
synced 2024-12-26 13:03:07 +00:00
Add documentation for skip and skip-while (#1499)
This commit is contained in:
parent
1ec2ec72b5
commit
1c4cb30d64
2 changed files with 79 additions and 0 deletions
46
docs/commands/skip-while.md
Normal file
46
docs/commands/skip-while.md
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
# skip-while
|
||||||
|
Skips rows while the condition matches.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```shell
|
||||||
|
> [input-command] | skip-while <condition>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
If we open a file with a list of contacts, we get all of the contacts.
|
||||||
|
```shell
|
||||||
|
> open contacts.csv | sort-by "last name"
|
||||||
|
───┬────────────┬───────────┬──────────────────
|
||||||
|
# │ first name │ last name │ email
|
||||||
|
───┼────────────┼───────────┼──────────────────
|
||||||
|
0 │ John │ Abbot │ abbot@email.com
|
||||||
|
1 │ Chris │ Beasly │ beasly@email.com
|
||||||
|
2 │ Jane │ Carver │ carver@email.com
|
||||||
|
3 │ Francis │ Davis │ davis@email.com
|
||||||
|
───┴────────────┴───────────┴──────────────────
|
||||||
|
```
|
||||||
|
|
||||||
|
To exclude skip contacts with last names startin with 'A' or 'B', use skip-while:
|
||||||
|
```shell
|
||||||
|
> open contacts.csv | sort-by "last name" | skip-while "last name" < "C"
|
||||||
|
───┬────────────┬───────────┬──────────────────
|
||||||
|
# │ first name │ last name │ email
|
||||||
|
───┼────────────┼───────────┼──────────────────
|
||||||
|
0 │ Jane │ Carver │ carver@email.com
|
||||||
|
1 │ Francis │ Davis │ davis@email.com
|
||||||
|
───┴────────────┴───────────┴──────────────────
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the order of input rows matters. Once a single row does not match the condition, all following rows are included in the output, whether or not they match the condition:
|
||||||
|
```shell
|
||||||
|
> open contacts.csv | skip-while "last name" < "C"
|
||||||
|
───┬────────────┬───────────┬──────────────────
|
||||||
|
# │ first name │ last name │ email
|
||||||
|
───┼────────────┼───────────┼──────────────────
|
||||||
|
0 │ Jane │ Carver │ carver@email.com
|
||||||
|
1 │ Chris │ Beasly │ beasly@email.com
|
||||||
|
2 │ Francis │ Davis │ davis@email.com
|
||||||
|
───┴────────────┴───────────┴──────────────────
|
||||||
|
```
|
||||||
|
See the `where` command to filter each individual row by a condition, regardless of order.
|
33
docs/commands/skip.md
Normal file
33
docs/commands/skip.md
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
# skip
|
||||||
|
Skips the first 'n' rows of a table.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```shell
|
||||||
|
> [input-command] | skip (n)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
If we open a file with a list of contacts, we get all of the contacts.
|
||||||
|
```shell
|
||||||
|
> open contacts.csv
|
||||||
|
───┬─────────┬──────┬─────────────────
|
||||||
|
# │ first │ last │ email
|
||||||
|
───┼─────────┼──────┼─────────────────
|
||||||
|
0 │ John │ Doe │ doe.1@email.com
|
||||||
|
1 │ Jane │ Doe │ doe.2@email.com
|
||||||
|
2 │ Chris │ Doe │ doe.3@email.com
|
||||||
|
3 │ Francis │ Doe │ doe.4@email.com
|
||||||
|
───┴─────────┴──────┴─────────────────
|
||||||
|
```
|
||||||
|
|
||||||
|
To ignore the first 2 contacts, we can `skip` them.
|
||||||
|
```shell
|
||||||
|
> open contacts.csv | skip 2
|
||||||
|
───┬─────────┬──────┬─────────────────
|
||||||
|
# │ first │ last │ email
|
||||||
|
───┼─────────┼──────┼─────────────────
|
||||||
|
0 │ Chris │ Doe │ doe.3@email.com
|
||||||
|
1 │ Francis │ Doe │ doe.4@email.com
|
||||||
|
───┴─────────┴──────┴─────────────────
|
||||||
|
```
|
Loading…
Reference in a new issue