docs(rust): note that weekday is actually ISO weekday (#9440)

pola-rs · Jun 19, 2023 · 56a58e3 · 56a58e3
1 parent 4f22b83
commit 56a58e3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/polars/polars-lazy/polars-plan/src/dsl/dt.rs b/polars/polars-lazy/polars-plan/src/dsl/dt.rs
@@ -146,10 +146,10 @@ impl DateLikeNameSpace {
             .map_private(FunctionExpr::TemporalExpr(TemporalFunction::Week))
     }
 
-    /// Extract the week day from the underlying Date representation.
+    /// Extract the ISO week day from the underlying Date representation.
     /// Can be performed on Date and Datetime.
 
-    /// Returns the weekday number where monday = 0 and sunday = 6
+    /// Returns the weekday number where monday = 1 and sunday = 7
     pub fn weekday(self) -> Expr {
         self.0
             .map_private(FunctionExpr::TemporalExpr(TemporalFunction::WeekDay))

diff --git a/polars/polars-time/src/chunkedarray/date.rs b/polars/polars-time/src/chunkedarray/date.rs
@@ -49,8 +49,8 @@ pub trait DateMethods: AsDate {
         ca.apply_kernel_cast::<UInt32Type>(&date_to_month)
     }
 
-    /// Extract weekday from underlying NaiveDate representation.
-    /// Returns the weekday number where monday = 0 and sunday = 6
+    /// Extract ISO weekday from underlying NaiveDate representation.
+    /// Returns the weekday number where monday = 1 and sunday = 7
     fn weekday(&self) -> UInt32Chunked {
         let ca = self.as_date();
         ca.apply_kernel_cast::<UInt32Type>(&date_to_iso_weekday)

diff --git a/polars/polars-time/src/series/mod.rs b/polars/polars-time/src/series/mod.rs
@@ -187,7 +187,7 @@ pub trait TemporalMethods: AsSeries {
             dt => polars_bail!(opq = day, dt),
         }
     }
-    /// Returns the weekday number where monday = 0 and sunday = 6
+    /// Returns the ISO weekday number where monday = 1 and sunday = 7
     fn weekday(&self) -> PolarsResult<UInt32Chunked> {
         let s = self.as_series();
         match s.dtype() {