Skip to content

Commit

Permalink
Fix some spelling errors in tzeit documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mjradwin committed Nov 2, 2023
1 parent c9b39fe commit eea9cdc
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 28 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1276,7 +1276,7 @@ Plag haMincha; Sunrise plus 10.75 halachic hours

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression. Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars. |
| [angle] | <code>number</code> | <code>8.5</code> | optional time for solar depression. Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. |

<a name="Zmanim+neitzHaChama"></a>

Expand Down Expand Up @@ -1339,7 +1339,7 @@ Returns an array with tzeit Date object and a 24-hour string formatted time.

| Param | Type | Description |
| --- | --- | --- |
| angle | <code>number</code> | degrees for solar depression. Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars. |
| angle | <code>number</code> | degrees for solar depression. Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars. |
| timeFormat | <code>Intl.DateTimeFormat</code> | |

<a name="Zmanim.formatTime"></a>
Expand Down Expand Up @@ -2305,10 +2305,10 @@ option (Tzeit Hakochavim) is calculated when the sun is 8.5° below the horizon.
These defaults can be changed using these options:
* `options.candleLightingMins` - minutes before sundown to light candles
* `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
Havdalah times are supressed when `options.havdalahMins=0`.
Havdalah times are suppressed when `options.havdalahMins=0`.
* `options.havdalahDeg` - degrees for solar depression for Havdalah.
Default is 8.5 degrees for 3 small stars. Use 7.083 degress for 3 medium-sized stars.
Havdalah times are supressed when `options.havdalahDeg=0`.
Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
Havdalah times are suppressed when `options.havdalahDeg=0`.

If both `options.candlelighting=true` and `options.location` is specified,
Chanukah candle-lighting times and minor fast start/end times will also be generated.
Expand Down Expand Up @@ -2818,8 +2818,8 @@ Options to configure which events are returned
| end | <code>Date</code> \| [<code>HDate</code>](#HDate) \| <code>number</code> | use specific end date (requires start date) |
| candlelighting | <code>boolean</code> | calculate candle-lighting and havdalah times |
| candleLightingMins | <code>number</code> | minutes before sundown to light candles (default 18) |
| havdalahMins | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72). If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim - Nightfall (the point when 3 small stars are observable in the night time sky with the naked eye). If `0`, Havdalah times are supressed. |
| havdalahDeg | <code>number</code> | degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degress for 3 medium-sized stars. If `0`, Havdalah times are supressed. |
| havdalahMins | <code>number</code> | minutes after sundown for Havdalah (typical values are 42, 50, or 72). If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim - Nightfall (the point when 3 small stars are observable in the night time sky with the naked eye). If `0`, Havdalah times are suppressed. |
| havdalahDeg | <code>number</code> | degrees for solar depression for Havdalah. Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars. If `0`, Havdalah times are suppressed. |
| sedrot | <code>boolean</code> | calculate parashah hashavua on Saturdays |
| il | <code>boolean</code> | Israeli holiday and sedra schedule |
| noMinorFast | <code>boolean</code> | suppress minor fasts |
Expand Down
12 changes: 6 additions & 6 deletions hebcal.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ declare module '@hebcal/core' {
/**
* @deprecated
* @param [angle=8.5] optional time for solar depression.
* Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars.
* Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
*/
tzeit(hdate: Date | HDate, angle?: number): Date;
/**
Expand Down Expand Up @@ -431,7 +431,7 @@ declare module '@hebcal/core' {
plagHaMincha(): Date;
/**
* @param [angle=8.5] optional time for solar depression.
* Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars.
* Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
*/
tzeit(angle?: number): Date;
/** Alias for sunrise */
Expand Down Expand Up @@ -459,7 +459,7 @@ declare module '@hebcal/core' {
* Returns an array with tzeit Date object and a 24-hour string formatted time.
* @deprecated
* @param angle optional time for solar depression.
* Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars.
* Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
*/
tzeitTime(angle: number, timeFormat: Intl.DateTimeFormat): any[];
}
Expand Down Expand Up @@ -577,14 +577,14 @@ declare module '@hebcal/core' {
* minutes after sundown for Havdalah (typical values are 42, 50, or 72).
* If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -
* Nightfall (the point when 3 small stars are observable in the night time sky with
* the naked eye). If `0`, Havdalah times are supressed.
* the naked eye). If `0`, Havdalah times are suppressed.
*/
havdalahMins?: number;
/**
* degrees for solar depression for Havdalah.
* Default is 8.5 degrees for 3 small stars.
* Use 7.083 degress for 3 medium-sized stars.
* Havdalah times are supressed when `havdalahDeg=0`.
* Use 7.083 degrees for 3 medium-sized stars.
* Havdalah times are suppressed when `havdalahDeg=0`.
*/
havdalahDeg?: number;
/** calculate parashah hashavua on Saturdays */
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
],
"scripts": {
"build:rollup": "rollup -c",
"build:babel": "babel src --out-dir dist --source-maps",
"build": "npm run po2json && npm run build:rollup",
"prepublish": "npm run build",
"po2json": "node ./po2json.js po/*.po",
Expand Down Expand Up @@ -71,13 +70,13 @@
"@rollup/plugin-node-resolve": "^15.2.3",
"@rollup/plugin-terser": "^0.4.4",
"ava": "^5.3.1",
"core-js": "^3.33.0",
"eslint": "^8.51.0",
"core-js": "^3.33.2",
"eslint": "^8.52.0",
"eslint-config-google": "^0.14.0",
"jsdoc": "^4.0.2",
"jsdoc-to-markdown": "^8.0.0",
"nyc": "^15.1.0",
"rollup": "^4.1.4",
"rollup": "^4.2.0",
"ttag-cli": "^1.10.6"
}
}
12 changes: 6 additions & 6 deletions src/hebcal.js
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,10 @@ function checkCandleOptions(options) {
* @property {number} havdalahMins - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
* If `undefined` (the default), calculate Havdalah according to Tzeit Hakochavim -
* Nightfall (the point when 3 small stars are observable in the night time sky with
* the naked eye). If `0`, Havdalah times are supressed.
* the naked eye). If `0`, Havdalah times are suppressed.
* @property {number} havdalahDeg - degrees for solar depression for Havdalah.
* Default is 8.5 degrees for 3 small stars. use 7.083 degress for 3 medium-sized stars.
* If `0`, Havdalah times are supressed.
* Default is 8.5 degrees for 3 small stars. use 7.083 degrees for 3 medium-sized stars.
* If `0`, Havdalah times are suppressed.
* @property {boolean} sedrot - calculate parashah hashavua on Saturdays
* @property {boolean} il - Israeli holiday and sedra schedule
* @property {boolean} noMinorFast - suppress minor fasts
Expand Down Expand Up @@ -530,10 +530,10 @@ export class HebrewCalendar {
* These defaults can be changed using these options:
* * `options.candleLightingMins` - minutes before sundown to light candles
* * `options.havdalahMins` - minutes after sundown for Havdalah (typical values are 42, 50, or 72).
* Havdalah times are supressed when `options.havdalahMins=0`.
* Havdalah times are suppressed when `options.havdalahMins=0`.
* * `options.havdalahDeg` - degrees for solar depression for Havdalah.
* Default is 8.5 degrees for 3 small stars. Use 7.083 degress for 3 medium-sized stars.
* Havdalah times are supressed when `options.havdalahDeg=0`.
* Default is 8.5 degrees for 3 small stars. Use 7.083 degrees for 3 medium-sized stars.
* Havdalah times are suppressed when `options.havdalahDeg=0`.
*
* If both `options.candlelighting=true` and `options.location` is specified,
* Chanukah candle-lighting times and minor fast start/end times will also be generated.
Expand Down
4 changes: 2 additions & 2 deletions src/zmanim.js
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ export class Zmanim {
}
/**
* @param {number} [angle=8.5] optional time for solar depression.
* Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars.
* Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
* @return {Date}
*/
tzeit(angle=8.5) {
Expand Down Expand Up @@ -388,7 +388,7 @@ export class Zmanim {
* Returns an array with tzeit Date object and a 24-hour string formatted time.
* @deprecated
* @param {number} angle degrees for solar depression.
* Default is 8.5 degrees for 3 small stars, use 7.083 degress for 3 medium-sized stars.
* Default is 8.5 degrees for 3 small stars, use 7.083 degrees for 3 medium-sized stars.
* @param {Intl.DateTimeFormat} timeFormat
* @return {Object[]}
*/
Expand Down

0 comments on commit eea9cdc

Please sign in to comment.