Clarify month docs

date-fns · Mar 12, 2024 · 2e3e8b6 · 2e3e8b6
1 parent 3611e63
commit 2e3e8b6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/getMonth/index.ts b/src/getMonth/index.ts
@@ -12,7 +12,7 @@ import { toDate } from "../toDate/index.js";
  *
  * @param date - The given date
  *
- * @returns The month
+ * @returns The month index (0-11)
  *
  * @example
  * // Which month is 29 February 2012?

diff --git a/src/setMonth/index.ts b/src/setMonth/index.ts
@@ -13,7 +13,7 @@ import { toDate } from "../toDate/index.js";
  * @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).
  *
  * @param date - The date to be changed
- * @param month - The month of the new date
+ * @param month - The month index to set (0-11)
  *
  * @returns The new date with the month set
  *