Clarify isWeekend docs (date-fns#3786)

Co-authored-by: Sasha Koss <[email protected]>
vanvuongngo · May 13, 2024 · c053552 · c053552
1 parent c13e2c6
commit c053552
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/isWeekend/index.ts b/src/isWeekend/index.ts
@@ -6,7 +6,7 @@ import { toDate } from "../toDate/index.js";
  * @summary Does the given date fall on a weekend?
  *
  * @description
- * Does the given date fall on a weekend?
+ * Does the given date fall on a weekend? A weekend is either Saturday (`6`) or Sunday (`0`).
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
  *