Add docs for polars related commands (#1394)

nushell · May 9, 2024 · 08aab5b · 08aab5b
1 parent c3436dc
commit 08aab5b
Show file tree

Hide file tree

Showing 116 changed files with 5,783 additions and 28 deletions.
diff --git a/commands/docs/dfr_datepart.md b/commands/docs/dfr_datepart.md
@@ -57,10 +57,10 @@ Creates an expression to capture multiple date parts
                 (dfr col datetime | dfr datepart minute | dfr as datetime_minute ),
                 (dfr col datetime | dfr datepart second | dfr as datetime_second ),
                 (dfr col datetime | dfr datepart nanosecond | dfr as datetime_ns ) ]
-╭─────┬───────────────┬─────────────────┬──────────────────┬───────────────┬────────────────┬──────────────────┬──────╮
-│   # │   datetime    │  datetime_year  │  datetime_month  │ datetime_day  │ datetime_hour  │ datetime_minute  │ ...  │
-├─────┼───────────────┼─────────────────┼──────────────────┼───────────────┼────────────────┼──────────────────┼──────┤
-│   0 │ 2 years ago   │            2021 │               12 │            30 │              1 │                2 │ ...  │
-╰─────┴───────────────┴─────────────────┴──────────────────┴───────────────┴────────────────┴──────────────────┴──────╯
+╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────────────────┬─────────────╮
+│ # │  datetime   │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ datetime_second │ datetime_ns │
+├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────────────────┼─────────────┤
+│ 0 │ 2 years ago │          2021 │             12 │           30 │             1 │               2 │               3 │   123456789 │
+╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────────────────┴─────────────╯
 
 ```
diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md
@@ -36,11 +36,10 @@ Converts ics formatted string to table
 ```nu
 > 'BEGIN:VCALENDAR
 END:VCALENDAR' | from ics
-╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬───────────╮
-│ # │   properties   │     events     │     alarms     │     to-Dos     │    journals    │   free-busys   │ timezones │
-├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼───────────┤
-│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0   │
-│   │                │                │                │                │                │                │ items]    │
-╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴───────────╯
+╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────╮
+│ # │   properties   │     events     │     alarms     │     to-Dos     │    journals    │   free-busys   │   timezones    │
+├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┤
+│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │
+╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────╯
 
 ```
diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md
@@ -62,7 +62,7 @@ Read a table from MessagePack
 │ # │      event_name      │     time     │
 ├───┼──────────────────────┼──────────────┤
 │ 0 │ Apollo 11 Landing    │ 54 years ago │
-│ 1 │ Nushell first commit │ 4 years ago  │
+│ 1 │ Nushell first commit │ 5 years ago  │
 ╰───┴──────────────────────┴──────────────╯
 
 ```

diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md
@@ -52,12 +52,12 @@ Compute a histogram for the types of files, with frequency column named freq
 Compute a histogram for a list of numbers
 ```nu
 > [1 2 1] | histogram
-╭────┬────────┬────────┬───────────┬─────────────┬────────────────────────────────────────────────────────────────────╮
-│  # │ value  │ count  │ quantile  │ percentage  │                             frequency                              │
-├────┼────────┼────────┼───────────┼─────────────┼────────────────────────────────────────────────────────────────────┤
-│  0 │      1 │      2 │      0.67 │ 66.67%      │ ****************************************************************** │
-│  1 │      2 │      1 │      0.33 │ 33.33%      │ *********************************                                  │
-╰────┴────────┴────────┴───────────┴─────────────┴────────────────────────────────────────────────────────────────────╯
+╭───┬───────┬───────┬──────────┬────────────┬────────────────────────────────────────────────────────────────────╮
+│ # │ value │ count │ quantile │ percentage │                             frequency                              │
+├───┼───────┼───────┼──────────┼────────────┼────────────────────────────────────────────────────────────────────┤
+│ 0 │     1 │     2 │     0.67 │ 66.67%     │ ****************************************************************** │
+│ 1 │     2 │     1 │     0.33 │ 33.33%     │ *********************************                                  │
+╰───┴───────┴───────┴──────────┴────────────┴────────────────────────────────────────────────────────────────────╯
 
 ```