Skip to content

docs: improve documentation for mutable vs immutable Params#3890

Open
DLWoodruff wants to merge 1 commit intoPyomo:mainfrom
DLWoodruff:doc-mutable-params
Open

docs: improve documentation for mutable vs immutable Params#3890
DLWoodruff wants to merge 1 commit intoPyomo:mainfrom
DLWoodruff:doc-mutable-params

Conversation

@DLWoodruff
Copy link
Copy Markdown
Contributor

@DLWoodruff DLWoodruff commented Mar 26, 2026

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:

  • An attempt (with the help of Gemini) to create better documentation for Params

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.

@DLWoodruff DLWoodruff marked this pull request as ready for review March 26, 2026 00:33
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 26, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.94%. Comparing base (52a29ae) to head (5a6b420).
⚠️ Report is 17 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3890      +/-   ##
==========================================
- Coverage   89.94%   88.94%   -1.00%     
==========================================
  Files         902      902              
  Lines      106354   106354              
==========================================
- Hits        95655    94593    -1062     
- Misses      10699    11761    +1062     
Flag Coverage Δ
builders 29.20% <ø> (-0.01%) ⬇️
default 86.23% <ø> (?)
expensive 35.65% <ø> (?)
linux 86.37% <ø> (-3.05%) ⬇️
linux_other 86.37% <ø> (-1.01%) ⬇️
oldsolvers 28.11% <ø> (+<0.01%) ⬆️
osx 82.71% <ø> (ø)
win 85.81% <ø> (-0.01%) ⬇️
win_other 85.81% <ø> (-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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Added sections for Performance vs. Flexibility, When to use Mutable, Comparison Table (Param vs. Var), and clearer information on updating parameters with set_value().
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.

1 participant