Skip to content

Commit 9850e1d

Browse files
hustcerhustcer
committed
Update docs
1 parent 788eb8b commit 9850e1d

File tree

9 files changed

+95
-28
lines changed

9 files changed

+95
-28
lines changed

‎.vuepress/configs/sidebar/command_categories.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
export const commandCategories = [
2-
'/commands/categories/.md',
32
'/commands/categories/bits.md',
43
'/commands/categories/bytes.md',
54
'/commands/categories/chart.md',

‎commands/docs/banner.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: banner
3+
categories: |
4+
default
5+
version: 0.103.0
6+
default: |
7+
Print a banner for Nushell with information about the project
8+
usage: |
9+
Print a banner for Nushell with information about the project
10+
editLink: false
11+
contributors: false
12+
---
13+
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
14+
15+
# `banner` for [default](/commands/categories/default.md)
16+
17+
<div class='command-title'>Print a banner for Nushell with information about the project</div>
18+
19+
## Signature
20+
21+
```> banner {flags} ```
22+
23+
## Flags
24+
25+
- `--short`: Only show startup time
26+
27+
28+
## Input/output types:
29+
30+
| input | output |
31+
| ----- | ------ |
32+
| any | any |

‎commands/docs/from_ics.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,10 @@ Converts ics formatted string to table
4040
```nu
4141
> 'BEGIN:VCALENDAR
4242
END:VCALENDAR' | from ics
43-
╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────╮
44-
│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │
45-
├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────┤
46-
│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 │
47-
│ │ │ │ │ │ │ │ items] │
48-
╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴───────────╯
43+
╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────╮
44+
│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ timezones │
45+
├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┤
46+
│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │
47+
╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────╯
4948
5049
```

‎commands/docs/histogram.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ Compute a histogram for the types of files, with frequency column named freq
5353
Compute a histogram for a list of numbers
5454
```nu
5555
> [1 2 1] | histogram
56-
╭────┬────────┬────────┬───────────┬─────────────┬────────────────────────────────────────────────────────────────────╮
57-
│ # │ value │ count │ quantile │ percentage │ frequency │
58-
├────┼────────┼────────┼───────────┼─────────────┼────────────────────────────────────────────────────────────────────┤
59-
│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │
60-
│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │
61-
╰────┴────────┴────────┴───────────┴─────────────┴────────────────────────────────────────────────────────────────────╯
56+
╭───┬───────┬───────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮
57+
│ # │ value │ count │ quantile │ percentage │ frequency │
58+
├───┼───────┼───────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤
59+
│ 0 │ 1 │ 2 │ 0.67 │ 66.67% │ ****************************************************************** │
60+
│ 1 │ 2 │ 1 │ 0.33 │ 33.33% │ ********************************* │
61+
╰───┴───────┴───────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯
6262
6363
```
6464

‎commands/docs/polars_datepart.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ Creates an expression to capture multiple date parts
6161
(polars col datetime | polars datepart minute | polars as datetime_minute ),
6262
(polars col datetime | polars datepart second | polars as datetime_second ),
6363
(polars col datetime | polars datepart nanosecond | polars as datetime_ns ) ]
64-
╭─────┬───────────────┬─────────────────┬──────────────────┬───────────────┬────────────────┬──────────────────┬──────╮
65-
│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ ... │
66-
├─────┼───────────────┼─────────────────┼──────────────────┼───────────────┼────────────────┼──────────────────┼──────┤
67-
│ 0 │ 3 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ ... │
68-
╰─────┴───────────────┴─────────────────┴──────────────────┴───────────────┴────────────────┴──────────────────┴──────╯
64+
╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮
65+
│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │
66+
├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤
67+
│ 0 │ 3 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 123456789 │
68+
╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯
6969
7070
```

‎commands/docs/pwd.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: pwd
3+
categories: |
4+
default
5+
version: 0.103.0
6+
default: |
7+
Return the current working directory
8+
usage: |
9+
Return the current working directory
10+
editLink: false
11+
contributors: false
12+
---
13+
<!-- This file is automatically generated. Please edit the command in https://github.com/nushell/nushell instead. -->
14+
15+
# `pwd` for [default](/commands/categories/default.md)
16+
17+
<div class='command-title'>Return the current working directory</div>
18+
19+
## Signature
20+
21+
```> pwd {flags} ```
22+
23+
## Flags
24+
25+
- `--physical, -P`: Resolve symbolic links
26+
27+
28+
## Input/output types:
29+
30+
| input | output |
31+
| ----- | ------ |
32+
| any | any |

‎commands/docs/to_msgpack.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ contributors: false
2020

2121
```> to msgpack {flags} ```
2222

23+
## Flags
24+
25+
- `--serialize, -s`: serialize nushell types that cannot be deserialized
26+
2327

2428
## Input/output types:
2529

‎commands/docs/to_msgpackz.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ contributors: false
2424

2525
- `--quality, -q {int}`: Quality of brotli compression (default 3)
2626
- `--window-size, -w {int}`: Window size for brotli compression (default 20)
27+
- `--serialize, -s`: serialize nushell types that cannot be deserialized
2728

2829

2930
## Input/output types:

‎commands/docs/update_cells.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ Update the zero value cells to empty strings.
4949
$value
5050
}
5151
}
52-
╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮
53-
│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │
54-
├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤
55-
│ 0 │ 37 │ │ │ │ 37 │ │ │
56-
╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯
52+
╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮
53+
│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │
54+
├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤
55+
│ 0 │ 37 │ │ │ │ 37 │ │ │
56+
╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯
5757
5858
```
5959

@@ -69,10 +69,10 @@ Update the zero value cells to empty strings in 2 last columns.
6969
$value
7070
}
7171
}
72-
╭──────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬───────────────┬──────────────╮
73-
│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │
74-
├──────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼───────────────┼──────────────┤
75-
│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │
76-
╰──────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴───────────────┴──────────────╯
72+
╭───┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────┬────────────╮
73+
│ # │ 2021-04-16 │ 2021-06-10 │ 2021-09-18 │ 2021-10-15 │ 2021-11-16 │ 2021-11-17 │ 2021-11-18 │
74+
├───┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤
75+
│ 0 │ 37 │ 0 │ 0 │ 0 │ 37 │ │ │
76+
╰───┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────┴────────────╯
7777
7878
```

0 commit comments

Comments
 (0)