Time#days_in_year returns the no of days in a given year #5163
Conversation
|
LGTM 👍 ? |
src/time.cr
Outdated
| @@ -398,6 +398,11 @@ struct Time | |||
| days[month] | |||
| end | |||
|
|
|||
| # Returns how many days are there in a year | |||
There was a problem hiding this comment.
Can we change description/comment like this?
# Returns number of days in *year*
#
# ```
# Time.days_in_year(1990) # => 365
# Time.days_in_year(2004) # => 366
# ```
That way, year is clearly identified as argument and the example provides a nice touch 😄
Thank you! ❤️ ❤️ ❤️
Ref: https://crystal-lang.org/docs/conventions/documenting_code.html
There was a problem hiding this comment.
There should be a . at the end of the doc sentence.
There was a problem hiding this comment.
@luislavena thanks for the link. I wasn't aware of that, changing the code to such format.
PS: There are similar methods without such code examples, would a PR with such doc changes be welcomed 😄 would love to contribute like that.
src/time.cr
Outdated
| @@ -398,6 +398,11 @@ struct Time | |||
| days[month] | |||
| end | |||
|
|
|||
| # Returns how many days are there in a year | |||
| def self.days_in_year(year : Int) : Int32 | |||
| days_in_month(year, 2) + 337 | |||
There was a problem hiding this comment.
A simpler implementation and more explicit: leap_year?(year) ? 366 : 365
There was a problem hiding this comment.
I agree and also faster. I will modify the code for that.
coderhs
force-pushed
the
feat/days_in_year
branch
from
49e3177
to
a9a17e0
Compare
|
@luislavena & @straight-shoota PR has been updated. |
Definitely @coderhs!!! All the contributions that introduce better and easier to use documentation are welcome! 😄 Thank you! |
|
@luislavena have added code example to |
In reference to issue #5157