Improve docstring for select_sif_problems
: clarify max_con=0
vs contype="unc"
and bounds
#457
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 PR improves the docstring of
select_sif_problems
to make it clearer and more user-friendly, by explaining subtle points that commonly cause confusion:Clarifies what
max_con=0
actually does:Explains what
contype="unc"
means:Adds an explicit note about variable bounds not being counted in
max_con
.Provides a clear idiom to get truly unconstrained problems:
Adds better structured explanation of:
only_*
flagsobjtype
andcontype
filterscustom_filter
Includes realistic examples covering typical use cases.