docs: snapshot toolkit — CHANGES entry + current API + toctree#199
Open
lmoresi wants to merge 1 commit into
Open
docs: snapshot toolkit — CHANGES entry + current API + toctree#199lmoresi wants to merge 1 commit into
lmoresi wants to merge 1 commit into
Conversation
…ring Post-merge cleanup for the snapshot-toolkit work (PRs #195, #196, #198) now landed on development. - CHANGES.md: new 2026-05-20 entry covering the toolkit and the #184 Lagrangian typo fix. Documents save_state/load_state surface, Model.tracker, on-disk v1.1 format, format-aware read_timestep, the state-as-dataclass contract, and how the existing write_timestep / write_checkpoint paths remain unchanged (different use cases). - docs/developer/design/in_memory_checkpoint_design.md: API-shape code example updated to current names (save_state/load_state with file= kwarg) — the draft snapshot/restore verbs were renamed in phase 5; the design discussion itself is unchanged. - docs/developer/guides/state-as-dataclass.md: example code updated to the current save_state/load_state names; pointer to the user guide added. - docs/developer/index.md: added guides/state-as-dataclass to the Guides toctree (it was orphaned, generating a "not included in any toctree" warning since #195 landed). docs-build succeeds with no snapshot-related warnings. Underworld development team with AI support from Claude Code (https://claude.com/claude-code)
Contributor
There was a problem hiding this comment.
Pull request overview
Updates developer documentation to reflect the post-merge snapshot toolkit API and eliminates a docs-build warning by including an orphaned guide in the developer toctree.
Changes:
- Add a 2026-05-20
CHANGES.mdentry summarizing the snapshot toolkit (in-memory + on-disk) and the Lagrangian typo fix. - Update snapshot-related docs examples to the current
Model.save_state()/Model.load_state(...)API (andfile=for on-disk). - Add
guides/state-as-dataclassto the developer docs toctree.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/developer/index.md | Adds guides/state-as-dataclass to the Guides toctree to prevent orphan warnings. |
| docs/developer/guides/state-as-dataclass.md | Updates example usage to save_state / load_state API. |
| docs/developer/design/in_memory_checkpoint_design.md | Updates API-shape example to current method names and file= parameter. |
| CHANGES.md | Adds a dated changelog entry describing the snapshot toolkit and the Lagrangian DDt typo fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Summary
Post-merge documentation cleanup for the snapshot toolkit (#195, #196, #198) now landed on development.
save_state/load_state/file=) instead of the draftsnapshot/restoreverbs that were renamed in phase 5. Discussion text unchanged.guides/state-as-dataclassadded to the Guides toctree (was orphaned since In-memory snapshot toolkit (git stash for timesteps) #195, generating a "not included in any toctree" warning).Test plan
pixi run -e amr-dev docs-buildsucceeds without snapshot- or state-as-dataclass-related warningsUnderworld development team with AI support from Claude Code