docs: migration page - #874
Merged
Merged
Conversation
Full rewrite of docs/src/migration.md per docs/reports/10-migration.md Part 2: the flow-integrator gotcha, the old->new spelling table, the call-signature changes, the three semantics changes that don't announce themselves (Lift(f::Function), OpenLoop wrong arity, the 4-positional flow-call misread), every deprecated.jl shim's actual error message, the five spellings that couldn't be shimmed and why, and the still-working-but-undocumented NamedTuple init= form. Every quoted error message and every "silent" behavior claim was live-verified against the current package rather than transcribed from BREAKING.md, which turned up two stale claims fixed here: BREAKING.md itself said a missing integrator gives a bare MethodError (it's a clean ExtensionError), and the spec's "NamedTuple form dropped" turned out to mean dropped from the docs, not the code -- it still works. Adds the two still-missing outbound links (geometry/lift.md, flows/simulation.md) to complete the acceptance criterion; the other three pages already linked here from earlier PRs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
Full rewrite of
docs/src/migration.md(was a 4-line stub) perdocs/reports/10-migration.mdPart 2 — the last content page in the docs rewrite (PR 12 of the split; PR 13 will dropdocs/attic/once this merges).## Start here: Flow needs an integrator— the single most common first failure## What was renamed— old→new spelling table## What changed shape— the flow call convention, constrained flows,augment=→variable_costate=, theis_keyword prefix## What changed meaning silently— three!!! warnings:Lift(f::Function)no longerisa AbstractHamiltonian,OpenLoopwrong-arity failing only at run time, and a genuine silent argument-position misread on the old 4-positional flow call against anOptimalControlFlow## What you get instead of an error— everysrc/deprecated.jlshim's actualPreconditionErrormessage## What could not be shimmed, and why— the 5 spellings that can't be intercepted, with the real current failure mode for each## Legacy initial guesses— harvested fromdocs/attic/manual-initial-guess.md## v1.x → v2.0— pointer intoBREAKING.md, not a copyEvery quoted error message and every "silent" behavior claim was live-verified against the current package rather than transcribed. That turned up two stale claims, both fixed in this PR:
BREAKING.mditself said a missing integrator gives a bareMethodError— it's actually a cleanExtensionErrornaming the missing package.attic/manual-initial-guess.md" turned out to mean dropped from the docs, not the code —init=(state=..., control=...)still works fine, it's just undocumented since@initbecame the recommended path.Adds the two still-missing outbound links (
geometry/lift.md,flows/simulation.md) to satisfy the acceptance criterion —geometry/overview.md,geometry/ad.md, andresults/solution.mdalready linked here from earlier PRs.Page is deliberately non-executing (plain fences, not
@example) since it exists to show spellings that error — stated at the top.Test plan
julia --project=docs docs/make.jlruns clean end to end (exit 0, zero unresolved@refs in any file this PR touches)src/deprecated.jl's actual output, not just re-read from source🤖 Generated with Claude Code