plot_timeseries does not handle returns type properly #62
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
1. added proper pd.DataFrame support to plot_timeseries 2. added annotations to plot_timeseries and reports.full 3. added returns and benchmark type checking to plot_timeseries and reports.full
|
You've used up your 5 PR reviews for this month under the Korbit Starter Plan. You'll get 5 more reviews on October 20th, 2024 or you can upgrade to Pro for unlimited PR reviews and enhanced features in your Korbit Console. |
|
I’ve found 1 issues in this PR, but you have exceeded your plan limits. Upgrade to Korbit Pro and ask for another review with |
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.
This Pull requests adresses #61
Summary of changes
Test evidences
To keep scope of the fix limited behavior of
reports.fullwhen strategy / returnes are passed aspd.DataFrameis kept as-is. Subject to a further bug report / inverstigationAny questions / suggestions let me know.
Sergey
Description by Korbit AI
What change is being made?
Add type annotations and input validation to
plot_timeseriesandfullfunctions to ensurereturnsis a pandas Series or DataFrame andbenchmarkis either None or a pandas Series.Why are these changes being made?
These changes improve the robustness of the code by enforcing type constraints, which helps prevent runtime errors due to incorrect input types. This approach enhances code readability and maintainability by clearly specifying expected input types and handling invalid inputs gracefully.