Add calendar callback months_in_year/1 #7417
Conversation
|
We should also add a function in Date that takes the year+calendar and invoke it. Similar to days_in_month: https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/calendar/date.ex#L171-L177 Other than that, this looks beautiful. |
Not all calendars have a constant 12 months in a year. This function returns the number of months for a given year. Calendar.ISO will return 12 for all years. Add Date.days_in_month/1 Date.days_in_month/1 takes a Date.t and delegates to the Date's calendar to invoke days_in_month/1 in the calendar module.
|
PR is updated to reflect the addition of |
|
❤️ 💚 💙 💛 💜 |
| @@ -176,6 +176,23 @@ defmodule Date do | |||
| calendar.days_in_month(year, month) | |||
| end | |||
|
|
|||
| @doc """ | |||
| Returns the number of days in the given `date` month. | |||
There was a problem hiding this comment.
Shouldn't it be "Returns the number of months in the given year"?
There was a problem hiding this comment.
Good catch @David-Gil, fixed in 7d621f6 💟
There was a problem hiding this comment.
Thank you! 😄 I didn't expect to contribute anything to Elixir 😅
|
Yes, good catch. Please do send a PR!
--
*José Valimwww.plataformatec.com.br
<http://www.plataformatec.com.br/>Founder and Director of R&D*
|
[ci skip] Thanks @David-Gil for #7417 (comment).
| @@ -232,6 +234,22 @@ defmodule Calendar.ISO do | |||
| def days_in_month(_, month) when month in [4, 6, 9, 11], do: 30 | |||
| def days_in_month(_, month) when month in 1..12, do: 31 | |||
|
|
|||
| @doc """ | |||
There was a problem hiding this comment.
What do you think about using the module variable in the @doc and @spec?
@doc """
Returns how many months there are in the given year.
## Example
iex> Calendar.ISO.months_in_year(2004)
#{@months_in_year}
"""
@impl true
@since "1.7.0"
@spec months_in_year(year) :: unquote(@months_in_year)
def months_in_year(_year) do
@months_in_year
endor maybe just remove the module variable and use 12 directly like it's done in days_in_month/2.
@doc """
Returns how many months there are in the given year.
## Example
iex> Calendar.ISO.months_in_year(2004)
12
"""
@impl true
@since "1.7.0"
@spec months_in_year(year) :: 12
def months_in_year(_year), do: 12
Not all calendars have a constant 12 months in
a year. This function returns the number of
months for a given year. Calendar.ISO will return
12 for all years.