Fix misleading docstring in the "create_cvxpy_problem" method#11
Merged
gourav3017 merged 1 commit intoPortPy-Project:masterfrom Jun 4, 2025
Merged
Conversation
gourav3017
approved these changes
Jun 4, 2025
Collaborator
gourav3017
left a comment
There was a problem hiding this comment.
Changes are appropriate. Adding them to PortPy
This file contains hidden or 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
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.
Summary
This pull request updates the docstring for the
create_cvxpy_problemmethod in theOptimizationclass to correct misleading information. It also fixes minor formatting issues (e.g., misaligned tabs) in thesolvemethod's docstring to improve consistency.Changes
create_cvxpy_problem:cvxpy.Problemobjectself.objandself.constraintssolvefor consistencyNotes