-
Notifications
You must be signed in to change notification settings - Fork 26
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
Use keyword-only parameters for backend optimization functions + do not use default value for optimization domain #53
Closed
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
bqth29
changed the title
Use keyword-only parameters for backend optimization functions
Use keyword-only parameters for backend optimization functions + do not use default value for optimization domain
Dec 31, 2023
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #53 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 36 36
Lines 1600 1600
=========================================
Hits 1600 1600 ☔ View full report in Codecov by Sentry. |
bqth29
added
the
refactoring
Existing code is refactored (no new feature, no breaking change)
label
May 28, 2024
3 tasks
Overriden by #78 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
duplicate
This issue or pull request already exists
refactoring
Existing code is refactored (no new feature, no breaking change)
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.
💬 Pull Request Description
Some parameters of the optimization-related functions of backend classes were using keyword-only parameters in a way that seemed quite arbitrary. This has been homogenized by putting all parameters as keyword-only, expect the optimization domain (
domain
) if applicable.The
domain
parameter also no longer has a default value (forminimize
,maximize
andoptimize
functions) to encourage users explicitely defining the optimization domain of their choice to avoid confusion.✔️ Check list
Before you open the pull request, make sure the following requirements are met.
🚀 New features
None
🐞 Bug fixes
None
📣 Supplementary information
Defining these parameters as keyword-only may have introduced breaking changes for users directly calling the impacted backend classes using a version <= 1.2.1.