BusinessDays.jl icon indicating copy to clipboard operation
BusinessDays.jl copied to clipboard

Documentation Clarification/Error in Tutorial.

Open snovum opened this issue 4 months ago • 0 comments

Hi quick question. The tutorial in the documentation states the following about tobday

# Adjust to next business day
julia> tobday(:USSettlement, Date(2015, 1, 1))
2015-01-02

However it appears this is only true if the input date is NOT a business day.

julia> isbday(:USNYSE, Date(2024,03,17))
false

julia> tobday(:USNYSE, Date(2024,03,17))
2024-03-18

If the input date is a business day tobday does NOT adjust to the NEXT business day, but rather returns the SAME business day.

julia> isbday(:USNYSE, Date(2024,03,18))
true

julia> tobday(:USNYSE, Date(2024,03,18))
2024-03-18

(One can argue what adjust means but I think that is asking an ambiguous term to do alot of work in a user manual.)

Should this distinction should be clarified in the documentation because it may lead to confusion and error as the package reaches an even wider audience? Thanks.

snovum avatar Mar 18 '24 21:03 snovum