Refactor selection logic for IRR #121
Merged
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
Created function to store default selection logic to allow user to insert their own selection logic for more than 1 real solution
Documented addition of IRR selection logic function. The new function contains default logic for selection of IRR Values. User may enter their own function with custom logic if required.
When attempting to push changes to GitHub, tests returned a "757:89: E501 Line too long (90 > 88)" error. Line 757 was shortened in this update.
WHen attemping to commit a change, a "Line too long" error occured. Line 757 has been shortened.
Kai-Striega
approved these changes
Apr 16, 2024
Comment on lines
+712
to
+714
| # default selection logic for IRR function when there are > 2 real solutions | ||
| def _irr_default_selection(eirr): | ||
| # check sign of all IRR solutions |
There was a problem hiding this comment.
Suggested change
| # default selection logic for IRR function when there are > 2 real solutions | |
| def _irr_default_selection(eirr): | |
| # check sign of all IRR solutions | |
| def _irr_default_selection(eirr): | |
| """Default selection logic for IRR function when there is > 1 real solution""" | |
| # check sign of all IRR solutions |
Python treats triple quoted strings directly following a function/method/class definition as docstrings. These are special comments that are used to document the function/method/class.
It dosen't matter for this function (as it's private), but, for public functions/methods/classes, please follow the numpydoc style guide.
There was a problem hiding this comment.
Also you currently have > 2 real solutions, this should be > 1 real solutions
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.
Logic for selection of IRR when more than 1 real value is found was refactored into a separate function, allowing for user customisation of selection logic if required.