myopic feature documentation

[ParticularlyPythonicBS]

Summary by CodeRabbit

• Documentation
  • Added comprehensive Myopic Optimization docs describing configuration, workflow, efficiency table semantics, backtracking behavior, performance/discounting notes, and cautions about limited foresight.
  • Added a "Myopic" entry to the documentation navigation.
  • Updated an existing cross-reference to use a referenced directive for clearer linking.

[coderabbitai]

Walkthrough

Documentation-only updates: adds docs/source/myopic.rst, inserts "myopic" into the docs toctree, and replaces a plain myopic label in docs/source/computational_implementation.rst with a :doc: cross-reference.

Changes

Cohort / File(s)	Summary
Myopic feature documentation docs/source/myopic.rst	Adds a new detailed document for Myopic Optimization covering configuration (scenario_mode = "myopic", [myopic] options), operational workflow (initialization, windowed solving, per-window efficiency updates), myopic_efficiency table semantics, backtracking on infeasibility, and notes on performance and amortization.
Documentation navigation and reference docs/source/index.rst, docs/source/computational_implementation.rst	Inserts myopic into the docs toctree and changes a plain myopic label to a :doc: cross-reference in the computational implementation document.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically describes the main change: adding documentation for the myopic feature, which is the primary focus of all three file modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/myopic_docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/source/myopic.rst`:
- Around line 65-68: Split the long sentence in the "Backtracking and Roll-back"
paragraph into shorter sentences to improve readability: locate the paragraph
describing the Myopic sequencer's roll-back mechanism (mentions "Myopic
sequencer", "roll-back", and "view_depth") and break the single long sentence
into two or three concise sentences — e.g., one sentence explaining that it will
back up to the previous window and re-solve with an expanded view_depth, and a
second sentence stating that if it cannot back up further the run will abort
with an error — preserving the original meaning and terminology.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0093b3 and 4b43e58.

📒 Files selected for processing (3)

• docs/source/computational_implementation.rst
• docs/source/index.rst
• docs/source/myopic.rst

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: setup and test (windows-latest, 3.13)
• GitHub Check: setup and test (windows-latest, 3.12)
• GitHub Check: setup and test (macos-latest, 3.13)
• GitHub Check: setup and test (macos-latest, 3.12)

🔇 Additional comments (7)

docs/source/myopic.rst (5)

1-8: LGTM!

The introduction clearly describes the myopic optimization concept and its purpose. The RST formatting is correct with proper title markup and reference label.

---

9-18: LGTM!

The framework overview provides a clear high-level description of the myopic extension's capabilities. The bullet points are well-organized and easy to understand.

---

19-40: LGTM!

The configuration section is well-structured with:

• Clear TOML example
• Detailed parameter descriptions
• Proper use of the .. important:: directive to highlight the critical database requirement

The technical details about view_depth and step_size are explained clearly with practical examples.

---

41-54: LGTM!

The "How it Works" section provides an excellent step-by-step walkthrough of the myopic optimization algorithm. The hierarchical structure with numbered steps and sub-steps makes the sequential process easy to follow. The term "ghost capacity" is particularly descriptive for planned but unbuilt technologies.

---

55-64: LGTM!

The Myopic Efficiency Table section clearly explains this critical internal data structure and its role in filtering technologies across optimization windows. The bullet points effectively describe the dynamic maintenance behavior.

docs/source/computational_implementation.rst (1)

470-470: LGTM!

The update properly uses the :doc: directive to reference the new myopic documentation. This creates a proper cross-reference link and is consistent with the documentation structure for other extensions like monte_carlo (line 469) and stochastics (line 472).

docs/source/index.rst (1)

8-8: LGTM!

The addition of myopic to the toctree properly integrates the new documentation into the main documentation index. The placement is consistent with the existing structure.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@docs/source/myopic.rst`:
- Line 83: The wording in the "Limited Foresight" bullet uses an informal phrase
("stupid but cost-saving"); replace it with a more formal alternative such as
"locally optimal but globally suboptimal" or "short-sighted but cost-effective"
and update the sentence around the ``view_depth`` reference so it reads: Myopic
mode cannot see beyond the specified ``view_depth``, which can lead the model to
make locally optimal but globally suboptimal (short-sighted but cost-effective)
decisions in early windows and cause rollbacks when later constraints enter the
visibility window—advise caution when setting ``view_depth`` relative to known
future constraints.
- Line 61: The term "visibility window" appears only once in the text (line
containing "* Items not built in a previous window's visibility window are
removed.") and is inconsistent with the rest of the doc; replace that phrase
with the established terminology used elsewhere (e.g., "look-ahead window" or
simply "window") so the line reads "* Items not built in a previous window's
look-ahead window are removed." (or "* Items not built in a previous window are
removed.") and scan the surrounding paragraphs to ensure the chosen term matches
uses of "view_depth" and "optimization windows".

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/source/myopic.rst`:
- Line 35: Fix the typo in the documentation string for the parameter
"view_depth": change "eachiteration" to "each iteration" in the sentence
describing view_depth so it reads "...visible to the model in each iteration."
Reference the "view_depth" line in the diff to locate and edit the text.