Fix abs2greg example

hebcal · Oct 20, 2024 · 81a698b · 81a698b
1 parent 61e7775
commit 81a698b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/greg.ts b/src/greg.ts
@@ -119,8 +119,8 @@ export function greg2abs(date: Date): number {
  * function would return only the date 13 November 2008.
  * @param abs - R.D. number of days
  * @example
- * const hd = new HDate(15, 'Cheshvan', 5769);
- * const date = hd.greg(); // 13 November 2008
+ * const abs = hebrew2abs(5769, months.CHESHVAN, 15);
+ * const date = abs2greg(abs); // 13 November 2008
  * const year = date.getFullYear(); // 2008
  * const monthNum = date.getMonth() + 1; // 11
  * const day = date.getDate(); // 13

diff --git a/src/hdate-base.ts b/src/hdate-base.ts
@@ -97,6 +97,8 @@ function assertNumber(n: any, name: string) {
  * @param year Hebrew year
  * @param month Hebrew month
  * @param day Hebrew date (1-30)
+ * @example
+ * const abs = hebrew2abs(5769, months.CHESHVAN, 15);
  */
 export function hebrew2abs(year: number, month: number, day: number): number {
   assertNumber(year, 'year');