Skip to content

Update documentation for total_capacity_limit - #1529

Merged
tsmbland merged 2 commits into
mainfrom
total_limit_docs
Sep 3, 2026
Merged

Update documentation for total_capacity_limit#1529
tsmbland merged 2 commits into
mainfrom
total_limit_docs

Conversation

@tsmbland

@tsmbland tsmbland commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

Description

Update the investment docs and schema to talk about total capacity limits

Fixes #1521

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc
  • Update release notes for the latest release if this PR adds a new feature or fixes a bug
    present in the previous release

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov

codecov Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.95%. Comparing base (7cd741d) to head (3726dba).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1529   +/-   ##
=======================================
  Coverage   90.95%   90.95%           
=======================================
  Files          61       61           
  Lines        9050     9050           
  Branches     9050     9050           
=======================================
  Hits         8231     8231           
  Misses        500      500           
  Partials      319      319           

☔ View full report in Codecov by Harness.
📢 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.

@tsmbland
tsmbland marked this pull request as ready for review September 3, 2026 09:51
Copilot AI lite review requested due to automatic review settings September 3, 2026 09:51

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The updated docs contain a few concrete clarity/LaTeX issues (allocation wording and equation subscripts) that should be corrected to avoid misleading or incorrectly rendered documentation.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR updates the investment documentation and the process_investment_constraints input schema to describe how total_capacity_limit works, alongside existing addition_limit constraints.

Changes:

  • Expanded docs/model/investment.md to document both addition_limit (new-build) and total_capacity_limit (total installed) constraints, including multi-agent scaling.
  • Updated schemas/input/process_investment_constraints.yaml to describe total_capacity_limit and how it is allocated across agents.
File summaries
File Description
schemas/input/process_investment_constraints.yaml Updates the schema description/notes for total_capacity_limit.
docs/model/investment.md Adds/expands documentation for investment constraints, including formulas and total capacity limits.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 4
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/model/investment.md
Comment on lines 164 to 167
\\[
\mathrm{MaxInstallableCapacity} = \mathrm{AdditionLimit} \times \Delta_{\mathrm{MSY}}
\times \mathrm{AgentPortion}
\mathrm{MaxInstallableCapacity}\_{p,r,y,g} = \mathrm{AdditionLimit}\_{p,r,y}
\cdot \Delta\_{\mathrm{MSY}} \cdot \mathrm{AgentPortion}\_{c,r,y,g}
\\]

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I never understood the deal with underscores, but these do render correctly, and they do not render if I remove the backslashes

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is because it's latex within markdown, and there's conflicting syntax. Looks good to me as it is.

Comment thread docs/model/investment.md Outdated
Comment thread docs/model/investment.md
Comment thread schemas/input/process_investment_constraints.yaml

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.30.

Benchmark suite Current: 3726dba Previous: 7cd741d Ratio
example_run/muse1_default example 415154604 ns 296044869 ns 1.40

This comment was automatically generated by workflow using github-action-benchmark.

@tsmbland
tsmbland merged commit 08682bd into main Sep 3, 2026
8 of 9 checks passed
@tsmbland
tsmbland deleted the total_limit_docs branch September 3, 2026 12:43
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.

Documentation for total capacity limit

3 participants