docs: improve documentation for mutable vs immutable Params#3890
Open
DLWoodruff wants to merge 5 commits intoPyomo:mainfrom
Open
docs: improve documentation for mutable vs immutable Params#3890DLWoodruff wants to merge 5 commits intoPyomo:mainfrom
DLWoodruff wants to merge 5 commits intoPyomo:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3890 +/- ##
=======================================
Coverage 89.93% 89.93%
=======================================
Files 902 902
Lines 106415 106415
=======================================
+ Hits 95701 95702 +1
+ Misses 10714 10713 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Added sections for Performance vs. Flexibility, When to use Mutable, Comparison Table (Param vs. Var), and clearer information on updating parameters with set_value().
DLWoodruff
force-pushed
the
doc-mutable-params
branch
from
f88653b to
5a6b420
Compare
jsiirola
reviewed
Apr 8, 2026
Member
jsiirola
left a comment
jsiirola
left a comment
There was a problem hiding this comment.
This is great. I have a couple questions, but nothing that would/should block merging.
doc/OnlineDocs/explanation/modeling/math_programming/parameters.rst
Outdated
Show resolved
Hide resolved
doc/OnlineDocs/explanation/modeling/math_programming/parameters.rst
Outdated
Show resolved
Hide resolved
doc/OnlineDocs/explanation/modeling/math_programming/parameters.rst
Outdated
Show resolved
Hide resolved
doc/OnlineDocs/explanation/modeling/math_programming/parameters.rst
Outdated
Show resolved
Hide resolved
…able-params # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
jsiirola
approved these changes
Apr 12, 2026
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
3 participants
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.
Added sections for Performance vs. Flexibility, When to use Mutable, Comparison Table (Param vs. Var), and clearer information on updating parameters with set_value().
Fixes # .
Summary/Motivation:
According to a web search, mutable vs. immutable issues are in the top ten troubles for new users (most of the others have something to do with solver status one way or the other)
Changes proposed in this PR:
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: