Add doc + types and moves 'special offsets' implementation to XKRX #177
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Extends documentation and adds type annotations to ExchangeCalendar "calendar-definition" properties. Also, adds 'black' to dev environment, as required by `pre-commit-config.yaml`. Also, a little general linting.
Moves 'special offsets' implementation from ExchangeCalendar to XKRX. Leaves a `apply_special_offsets` hook into the ExchangeCalendar constructor.
|
@gerrymanoim, I'm going to merge this to conclude v3 and get started on v4. Most of this one is doc and typing improvements. The only part that might be controversial is moving the 'special offsets' implementation from |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Extends documentation and adds type annotations to
ExchangeCalendar"calendar-definition" properties.Moves 'special offsets' implementation from
ExchangeCalendartoXKRXExchangeCalendar(leaving aapply_special_offsetshook into theExchangeCalendarconstructor). The implementation added a fair bit of bulk toExchangeCalendaralthough is used only byXKRXExchangeCalendar. Given that no other calendar uses it, and that it's anticipatedXKRXExchangeCalendarwill move to hardcoded dates anyway (#128), this PR explicitly makes the implementation specific toXKRXExchangeCalendar.Also