holidays / holidays

A collection of Ruby methods to deal with statutory and other holidays. You deserve a holiday!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Better document how we handle 'wildcard' regions

ppeble opened this issue · comments

We have functionality in the gem that allows for users to enter regions like :au_ but we do not do a good job with documenting what exactly happens in this case. A good PR for an beginner is to document exactly what happens in different scenarios/regions/dates and modify the README with examples so new users will be more familiar with the behavior of the gem.

NOTE - I have a feeling that the current handling of wildcards is not intuitive. You might find weird behavior! This is not a problem, just explain what you are seeing in this PR and we can help diagnose the issue.