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

Use keyword-only parameters for backend optimization functions + do not use default value for optimization domain #53

Closed
wants to merge 12 commits into from

Conversation

bqth29
Copy link
Owner

@bqth29 bqth29 commented Dec 31, 2023

💬 Pull Request Description

⚠️ This PR contains breaking changes. See at the bottom of this description for more information.

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 (for minimize, maximize and optimize 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.

  • The code matches the styling rules
  • The new code is covered by relevant tests
  • Documentation was added

🚀 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.

@bqth29 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
Copy link

codecov bot commented Dec 31, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6194a9e) to head (3137751).
Report is 6 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@bqth29 bqth29 added the refactoring Existing code is refactored (no new feature, no breaking change) label May 28, 2024
@bqth29
Copy link
Owner Author

bqth29 commented Sep 29, 2024

Overriden by #78

@bqth29 bqth29 added the duplicate This issue or pull request already exists label Sep 29, 2024
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)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant