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

Fix documentation of linear_only argument in get_incident_variables #3067

Merged
merged 1 commit into from
Dec 13, 2023

Conversation

Robbybp
Copy link
Contributor

@Robbybp Robbybp commented Dec 12, 2023

Fixes

Discrepancy between documentation and behavior

Summary/Motivation:

In #2883, I fixed the behavior of the linear_only argument in get_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 the linear_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:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

Copy link

codecov bot commented Dec 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4e5121a) 88.09% compared to head (857105a) 88.09%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3067   +/-   ##
=======================================
  Coverage   88.09%   88.09%           
=======================================
  Files         774      774           
  Lines       91537    91537           
=======================================
+ Hits        80636    80644    +8     
+ Misses      10901    10893    -8     
Flag Coverage Δ
linux 85.45% <ø> (ø)
osx 75.47% <ø> (ø)
other 85.63% <ø> (ø)
win 82.80% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jsiirola jsiirola merged commit 809a58a into Pyomo:main Dec 13, 2023
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants