Renamed join_where to join-where (#15660)

Renames the new `polars join_where` to `polars join-where` so that it
conforms to the other Polars commands.
This commit is contained in:
Douglas 2025-04-29 11:17:28 -04:00 committed by GitHub
parent 09f12b9c4a
commit a1b7574306
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -15,7 +15,7 @@ impl PluginCommand for LazyJoinWhere {
type Plugin = PolarsPlugin;
fn name(&self) -> &str {
"polars join_where"
"polars join-where"
}
fn description(&self) -> &str {
@ -38,7 +38,7 @@ impl PluginCommand for LazyJoinWhere {
description: "Join two lazy dataframes with a condition",
example: r#"let df_a = ([[name cash];[Alice 5] [Bob 10]] | polars into-lazy)
let df_b = ([[item price];[A 3] [B 7] [C 12]] | polars into-lazy)
$df_a | polars join_where $df_b ((polars col cash) > (polars col price)) | polars collect"#,
$df_a | polars join-where $df_b ((polars col cash) > (polars col price)) | polars collect"#,
result: Some(
NuDataFrame::try_from_columns(
vec![