Fix documentation of linear_only
argument in get_incident_variables
#3067
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.
Fixes
Discrepancy between documentation and behavior
Summary/Motivation:
In #2883, I fixed the behavior of the
linear_only
argument inget_incident_variables
, and claimed that the old behavior (identifying variables that participate linearly even if they also participate nonlinearly) was not my intention. Funnily enough, the documentation of thelinear_only
option clearly states that variables that are "both linear and nonlinear" will be returned (even though this is mathematically incorrect). This PR fixes the documentation.Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: