From 7dbda76fad62935ac00670723e93349c71cdff61 Mon Sep 17 00:00:00 2001 From: Hofer-Julian <30049909+Hofer-Julian@users.noreply.github.com> Date: Fri, 6 Oct 2023 18:55:29 +0200 Subject: [PATCH] Add long options for core and dataframes (#10619) --- crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs | 5 +++-- crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs | 2 +- crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs | 2 +- .../nu-cmd-dataframe/src/dataframe/series/date/get_day.rs | 2 +- .../src/dataframe/series/date/get_hour.rs | 2 +- .../src/dataframe/series/date/get_minute.rs | 2 +- .../src/dataframe/series/date/get_month.rs | 2 +- .../src/dataframe/series/date/get_nanosecond.rs | 2 +- .../src/dataframe/series/date/get_ordinal.rs | 2 +- .../src/dataframe/series/date/get_second.rs | 2 +- .../src/dataframe/series/date/get_week.rs | 2 +- .../src/dataframe/series/date/get_weekday.rs | 2 +- .../src/dataframe/series/date/get_year.rs | 2 +- .../src/dataframe/series/indexes/arg_sort.rs | 2 +- .../src/dataframe/series/indexes/set_with_idx.rs | 2 +- .../src/dataframe/series/string/replace.rs | 2 +- .../src/dataframe/series/string/replace_all.rs | 2 +- .../src/dataframe/series/string/str_slice.rs | 2 +- .../src/dataframe/series/string/strftime.rs | 2 +- crates/nu-cmd-lang/src/core_commands/do_.rs | 8 ++++---- crates/nu-cmd-lang/src/core_commands/lazy_make.rs | 2 +- 21 files changed, 26 insertions(+), 25 deletions(-) diff --git a/crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs b/crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs index 4730ec09e..8f008fe68 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/eager/sample.rs @@ -52,12 +52,13 @@ impl Command for SampleDF { vec![ Example { description: "Sample rows from dataframe", - example: "[[a b]; [1 2] [3 4]] | dfr into-df | dfr sample -n 1", + example: "[[a b]; [1 2] [3 4]] | dfr into-df | dfr sample --n-rows 1", result: None, // No expected value because sampling is random }, Example { description: "Shows sample row using fraction and replace", - example: "[[a b]; [1 2] [3 4] [5 6]] | dfr into-df | dfr sample -f 0.5 -e", + example: + "[[a b]; [1 2] [3 4] [5 6]] | dfr into-df | dfr sample --fraction 0.5 --replace", result: None, // No expected value because sampling is random }, ] diff --git a/crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs b/crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs index 0f416b6f7..fee8a5711 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/eager/to_csv.rs @@ -45,7 +45,7 @@ impl Command for ToCSV { }, Example { description: "Saves dataframe to CSV file using other delimiter", - example: "[[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv -d '|'", + example: "[[a b]; [1 2] [3 4]] | dfr into-df | dfr to-csv test.csv --delimiter '|'", result: None, }, ] diff --git a/crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs b/crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs index f97ba42cd..ee91b942b 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/eager/to_nu.rs @@ -61,7 +61,7 @@ impl Command for ToNu { }, Example { description: "Shows tail rows from dataframe", - example: "[[a b]; [1 2] [5 6] [3 4]] | dfr into-df | dfr into-nu -t -n 1", + example: "[[a b]; [1 2] [5 6] [3 4]] | dfr into-df | dfr into-nu --tail --rows 1", result: Some(Value::list(vec![rec_3], Span::test_data())), }, Example { diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_day.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_day.rs index 51ded86e0..62ab8f553 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_day.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_day.rs @@ -31,7 +31,7 @@ impl Command for GetDay { fn examples(&self) -> Vec { vec![Example { description: "Returns day from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-day"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_hour.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_hour.rs index 548edb426..4776f0034 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_hour.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_hour.rs @@ -31,7 +31,7 @@ impl Command for GetHour { fn examples(&self) -> Vec { vec![Example { description: "Returns hour from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-hour"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_minute.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_minute.rs index de5dd9d5c..5db7396b0 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_minute.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_minute.rs @@ -31,7 +31,7 @@ impl Command for GetMinute { fn examples(&self) -> Vec { vec![Example { description: "Returns minute from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-minute"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_month.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_month.rs index 58d0cba22..74ec4a978 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_month.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_month.rs @@ -31,7 +31,7 @@ impl Command for GetMonth { fn examples(&self) -> Vec { vec![Example { description: "Returns month from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-month"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_nanosecond.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_nanosecond.rs index f36e4c7af..c34688dc1 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_nanosecond.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_nanosecond.rs @@ -31,7 +31,7 @@ impl Command for GetNanosecond { fn examples(&self) -> Vec { vec![Example { description: "Returns nanosecond from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-nanosecond"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_ordinal.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_ordinal.rs index 40d245121..58d20e33c 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_ordinal.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_ordinal.rs @@ -31,7 +31,7 @@ impl Command for GetOrdinal { fn examples(&self) -> Vec { vec![Example { description: "Returns ordinal from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-ordinal"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_second.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_second.rs index 74b7fa890..39b630815 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_second.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_second.rs @@ -31,7 +31,7 @@ impl Command for GetSecond { fn examples(&self) -> Vec { vec![Example { description: "Returns second from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-second"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_week.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_week.rs index ba39d1863..eb1b76c09 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_week.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_week.rs @@ -31,7 +31,7 @@ impl Command for GetWeek { fn examples(&self) -> Vec { vec![Example { description: "Returns week from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-week"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_weekday.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_weekday.rs index 668c32c64..27c731f2a 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_weekday.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_weekday.rs @@ -31,7 +31,7 @@ impl Command for GetWeekDay { fn examples(&self) -> Vec { vec![Example { description: "Returns weekday from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-weekday"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_year.rs b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_year.rs index 991d347c7..99d5f42f8 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/date/get_year.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/date/get_year.rs @@ -31,7 +31,7 @@ impl Command for GetYear { fn examples(&self) -> Vec { vec![Example { description: "Returns year from a date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr get-year"#, result: Some( diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/indexes/arg_sort.rs b/crates/nu-cmd-dataframe/src/dataframe/series/indexes/arg_sort.rs index be97e2308..5fcf69b12 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/indexes/arg_sort.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/indexes/arg_sort.rs @@ -61,7 +61,7 @@ impl Command for ArgSort { }, Example { description: "Returns indexes for a sorted series", - example: "[1 2 2 3 3] | dfr into-df | dfr arg-sort -r", + example: "[1 2 2 3 3] | dfr into-df | dfr arg-sort --reverse", result: Some( NuDataFrame::try_from_columns(vec![Column::new( "arg_sort".to_string(), diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/indexes/set_with_idx.rs b/crates/nu-cmd-dataframe/src/dataframe/series/indexes/set_with_idx.rs index 33b3d8795..1dc290752 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/indexes/set_with_idx.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/indexes/set_with_idx.rs @@ -41,7 +41,7 @@ impl Command for SetWithIndex { description: "Set value in selected rows from series", example: r#"let series = ([4 1 5 2 4 3] | dfr into-df); let indices = ([0 2] | dfr into-df); - $series | dfr set-with-idx 6 -i $indices"#, + $series | dfr set-with-idx 6 --indices $indices"#, result: Some( NuDataFrame::try_from_columns(vec![Column::new( "0".to_string(), diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/string/replace.rs b/crates/nu-cmd-dataframe/src/dataframe/series/string/replace.rs index f0b36ddb2..e329a2670 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/string/replace.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/string/replace.rs @@ -44,7 +44,7 @@ impl Command for Replace { fn examples(&self) -> Vec { vec![Example { description: "Replaces string", - example: "[abc abc abc] | dfr into-df | dfr replace -p ab -r AB", + example: "[abc abc abc] | dfr into-df | dfr replace --pattern ab --replace AB", result: Some( NuDataFrame::try_from_columns(vec![Column::new( "0".to_string(), diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/string/replace_all.rs b/crates/nu-cmd-dataframe/src/dataframe/series/string/replace_all.rs index 02532e409..eb3a0ec6f 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/string/replace_all.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/string/replace_all.rs @@ -44,7 +44,7 @@ impl Command for ReplaceAll { fn examples(&self) -> Vec { vec![Example { description: "Replaces string", - example: "[abac abac abac] | dfr into-df | dfr replace-all -p a -r A", + example: "[abac abac abac] | dfr into-df | dfr replace-all --pattern a --replace A", result: Some( NuDataFrame::try_from_columns(vec![Column::new( "0".to_string(), diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/string/str_slice.rs b/crates/nu-cmd-dataframe/src/dataframe/series/string/str_slice.rs index 3c8ec8532..4a5e7f430 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/string/str_slice.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/string/str_slice.rs @@ -34,7 +34,7 @@ impl Command for StrSlice { fn examples(&self) -> Vec { vec![Example { description: "Creates slices from the strings", - example: "[abcded abc321 abc123] | dfr into-df | dfr str-slice 1 -l 2", + example: "[abcded abc321 abc123] | dfr into-df | dfr str-slice 1 --length 2", result: Some( NuDataFrame::try_from_columns(vec![Column::new( "0".to_string(), diff --git a/crates/nu-cmd-dataframe/src/dataframe/series/string/strftime.rs b/crates/nu-cmd-dataframe/src/dataframe/series/string/strftime.rs index 530770a60..2340ddee1 100644 --- a/crates/nu-cmd-dataframe/src/dataframe/series/string/strftime.rs +++ b/crates/nu-cmd-dataframe/src/dataframe/series/string/strftime.rs @@ -33,7 +33,7 @@ impl Command for StrFTime { fn examples(&self) -> Vec { vec![Example { description: "Formats date", - example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); + example: r#"let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); let df = ([$dt $dt] | dfr into-df); $df | dfr strftime "%Y/%m/%d""#, result: Some( diff --git a/crates/nu-cmd-lang/src/core_commands/do_.rs b/crates/nu-cmd-lang/src/core_commands/do_.rs index 796693026..79c15f5a6 100644 --- a/crates/nu-cmd-lang/src/core_commands/do_.rs +++ b/crates/nu-cmd-lang/src/core_commands/do_.rs @@ -275,22 +275,22 @@ impl Command for Do { }, Example { description: "Run the closure and ignore both shell and external program errors", - example: r#"do -i { thisisnotarealcommand }"#, + example: r#"do --ignore-errors { thisisnotarealcommand }"#, result: None, }, Example { description: "Run the closure and ignore shell errors", - example: r#"do -s { thisisnotarealcommand }"#, + example: r#"do --ignore-shell-errors { thisisnotarealcommand }"#, result: None, }, Example { description: "Run the closure and ignore external program errors", - example: r#"do -p { nu -c 'exit 1' }; echo "I'll still run""#, + example: r#"do --ignore-program-errors { nu --commands 'exit 1' }; echo "I'll still run""#, result: None, }, Example { description: "Abort the pipeline if a program returns a non-zero exit code", - example: r#"do -c { nu -c 'exit 1' } | myscarycommand"#, + example: r#"do --capture-errors { nu --commands 'exit 1' } | myscarycommand"#, result: None, }, Example { diff --git a/crates/nu-cmd-lang/src/core_commands/lazy_make.rs b/crates/nu-cmd-lang/src/core_commands/lazy_make.rs index c7c1aab29..7f5635b14 100644 --- a/crates/nu-cmd-lang/src/core_commands/lazy_make.rs +++ b/crates/nu-cmd-lang/src/core_commands/lazy_make.rs @@ -88,7 +88,7 @@ impl Command for LazyMake { }, Example { description: "Test the laziness of lazy records", - example: r#"lazy make -c ["hello"] -g { |key| print $"getting ($key)!"; $key | str upcase }"#, + example: r#"lazy make --columns ["hello"] --get-value { |key| print $"getting ($key)!"; $key | str upcase }"#, result: None, }, ]