Skip to content

Commit

Permalink
Refresh commands doc for v0.85
Browse files Browse the repository at this point in the history
  • Loading branch information
hustcer committed Sep 20, 2023
1 parent efb90fb commit 96cc32b
Show file tree
Hide file tree
Showing 489 changed files with 1,383 additions and 579 deletions.
3 changes: 2 additions & 1 deletion commands/docs/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: alias
categories: |
core
version: 0.84.0
version: 0.85.0
core: |
Alias a command (with optional flags) to a new name.
usage: |
Alias a command (with optional flags) to a new name.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for core

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/all.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: all
categories: |
filters
version: 0.84.0
version: 0.85.0
filters: |
Test if every element of the input fulfills a predicate expression.
usage: |
Test if every element of the input fulfills a predicate expression.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for filters

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/ansi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: ansi
categories: |
platform
version: 0.84.0
version: 0.85.0
platform: |
Output ANSI codes to change color and style of text.
usage: |
Output ANSI codes to change color and style of text.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/ansi_gradient.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: ansi gradient
categories: |
platform
version: 0.84.0
version: 0.85.0
platform: |
Add a color gradient (using ANSI color codes) to the given string.
usage: |
Add a color gradient (using ANSI color codes) to the given string.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/ansi_link.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: ansi link
categories: |
platform
version: 0.84.0
version: 0.85.0
platform: |
Add a link (using OSC 8 escape sequence) to the given string.
usage: |
Add a link (using OSC 8 escape sequence) to the given string.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/ansi_strip.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: ansi strip
categories: |
platform
version: 0.84.0
version: 0.85.0
platform: |
Strip ANSI escape sequences from a string.
usage: |
Strip ANSI escape sequences from a string.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for platform

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/any.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: any
categories: |
filters
version: 0.84.0
version: 0.85.0
filters: |
Tests if any element of the input fulfills a predicate expression.
usage: |
Tests if any element of the input fulfills a predicate expression.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for filters

Expand Down
22 changes: 18 additions & 4 deletions commands/docs/append.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: append
categories: |
filters
version: 0.84.0
version: 0.85.0
filters: |
Append any number of rows to a table.
usage: |
Append any number of rows to a table.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for filters

Expand All @@ -32,7 +33,7 @@ usage: |

Append one integer to a list
```shell
> [0,1,2,3] | append 4
> [0 1 2 3] | append 4
╭───┬───╮
│ 0 │ 0 │
│ 1 │ 1 │
Expand Down Expand Up @@ -67,7 +68,7 @@ Append a list of string to a string

Append three integer items
```shell
> [0,1] | append [2,3,4]
> [0 1] | append [2 3 4]
╭───┬───╮
│ 0 │ 0 │
│ 1 │ 1 │
Expand All @@ -80,7 +81,7 @@ Append three integer items

Append integers and strings
```shell
> [0,1] | append [2,nu,4,shell]
> [0 1] | append [2 nu 4 shell]
╭───┬───────╮
│ 0 │ 0 │
│ 1 │ 1 │
Expand All @@ -92,6 +93,19 @@ Append integers and strings

```

Append a range of integers to a list
```shell
> [0 1] | append 2..4
╭───┬───╮
│ 0 │ 0 │
│ 1 │ 1 │
│ 2 │ 2 │
│ 3 │ 3 │
│ 4 │ 4 │
╰───┴───╯

```

## Notes
Be aware that this command 'unwraps' lists passed to it. So, if you pass a variable to it,
and you want the variable's contents to be appended without being unwrapped, it's wise to
Expand Down
3 changes: 2 additions & 1 deletion commands/docs/ast.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: ast
categories: |
debug
version: 0.84.0
version: 0.85.0
debug: |
Print the abstract syntax tree (ast) for a pipeline.
usage: |
Print the abstract syntax tree (ast) for a pipeline.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for debug

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Various commands for working with bits.
usage: |
Various commands for working with bits.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_and.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits and
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Performs bitwise and for integers.
usage: |
Performs bitwise and for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_not.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits not
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Performs logical negation on each bit.
usage: |
Performs logical negation on each bit.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_or.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits or
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Performs bitwise or for integers.
usage: |
Performs bitwise or for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_rol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits rol
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Bitwise rotate left for integers.
usage: |
Bitwise rotate left for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_ror.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits ror
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Bitwise rotate right for integers.
usage: |
Bitwise rotate right for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_shl.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits shl
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Bitwise shift left for integers.
usage: |
Bitwise shift left for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_shr.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits shr
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Bitwise shift right for integers.
usage: |
Bitwise shift right for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bits_xor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bits xor
categories: |
bits
version: 0.84.0
version: 0.85.0
bits: |
Performs bitwise xor for integers.
usage: |
Performs bitwise xor for integers.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bits

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/break.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: break
categories: |
core
version: 0.84.0
version: 0.85.0
core: |
Break a loop.
usage: |
Break a loop.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for core

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bytes
categories: |
bytes
version: 0.84.0
version: 0.85.0
bytes: |
Various commands for working with byte data.
usage: |
Various commands for working with byte data.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bytes

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bytes_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bytes add
categories: |
bytes
version: 0.84.0
version: 0.85.0
bytes: |
Add specified bytes to the input.
usage: |
Add specified bytes to the input.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bytes

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bytes_at.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bytes at
categories: |
bytes
version: 0.84.0
version: 0.85.0
bytes: |
Get bytes defined by a range
usage: |
Get bytes defined by a range
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bytes

Expand Down
3 changes: 2 additions & 1 deletion commands/docs/bytes_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
title: bytes build
categories: |
bytes
version: 0.84.0
version: 0.85.0
bytes: |
Create bytes from the arguments.
usage: |
Create bytes from the arguments.
---
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->

# <code>{{ $frontmatter.title }}</code> for bytes

Expand Down
Loading

0 comments on commit 96cc32b

Please sign in to comment.