-
Notifications
You must be signed in to change notification settings - Fork 281
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Issue-230: add load_all method to Holidays namespace to preload all d… #233
Conversation
…efinitions (i.e. no lazy loading)
I took the opportunity to remove all of the old comments in the main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.:)
@@ -9,44 +9,6 @@ | |||
require 'holidays/errors' | |||
require 'holidays/load_all_definitions' | |||
|
|||
# == Region options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are all these comments meant to be removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. They were out of date in some cases and honestly I'm not a huge fan of in-code comments like this. I believe that the code should be self-documenting and, if additional doc is needed, the README should fill in the gaps.
Thoughts? Was this kind of documentation useful to you? I'm open to discussing it, although I would want to re-add it in another PR/issue so that they are up to date if we do go that route.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just thought maybe it was a mistake since it was committed with this patch. I guess it's covered in the readme. I think it's fine for this project with not so many methods, for larger projects like Rails I think inline commenting is useful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point. I'm not as anti-comment as some of my coworkers (who refuse to allow any of them, ever). I bet that you and I are probably pretty close on what we would find 'acceptable'.
In this case I'll merge this and think about the best way to document for future developers.
Thanks!
Fixes #230