hebcal/hebcal-es6

Language mismatch between hDate.getMonthName and its documentation.

Closed this issue · 1 comments

According to the ReadMe:

hDate.getMonthName() ⇒ string

Returns untranslated Hebrew month name.

Since it returns the English transliteration for the Hebrew month, either the docs should be:

Returns the English transliteration of the Hebrew month (without regard to locale).

Or the function should be changed to return the Hebrew month in Hebrew.

Updated documentation to clarify that HDate.getMonthName() always returns an English transliteration.