Skip to content
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

Documentation Clarification/Error in Tutorial. #65

Open
snovum opened this issue Mar 18, 2024 · 0 comments
Open

Documentation Clarification/Error in Tutorial. #65

snovum opened this issue Mar 18, 2024 · 0 comments

Comments

@snovum
Copy link

snovum commented Mar 18, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant