Updates stale doc passages that predate Position - #217
Merged
Conversation
docs/durable-timers.md Route B claimed no MachineState serialization
exists in lib/ and pointed at the closed bead that owned the gap. The
passage now names Statifier.Position.to_binary/1 / from_binary/2
(ADR-0052, ADR-0060), the deliberate nil routes/invoke_types on resume
(ADR-0064), and defers to docs/persistence.md for the full recipe.
docs/testing-charts.md showed {:statifier, "~> 2.0"} as the dep line,
but nothing ships on Hex before 2.0.0. The example is now the
SHA-pinned git dep from README.md per ADR-0061, with the Hex form
noted as post-2.0.0.
Refs: st-qmhx
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.
Why
Two documentation passages predate landed work and mislead a host
following them (st-qmhx):
docs/durable-timers.md(Route B, process-less hosts) still claimedno MachineState serialization function exists in
lib/and pointedat st-m5c3 as the bead that owns the gap - but st-m5c3 is closed:
Statifier.Positionshippedto_binary/1/from_binary/2(ADR-0052, ADR-0060).
docs/testing-charts.mdshowed{:statifier, "~> 2.0"}as the depline, but nothing ships on Hex before 2.0.0 (ADR-0061).
What
Statifier.Position.to_binary/1/from_binary/2, the deliberatenilroutes/invoke_typeson resume (ADR-0064), and defers todocs/persistence.mdfor the full recipe.dep from README.md per ADR-0061, with the Hex
~> 2.0form noted aspost-2.0.0.
Notes
mix qualityand
mix quality --profile mergeboth ran green anyway; the ADRjudge skipped (no files in a judged scope).
docs/durable-timers.md, but only thecaller_context section (~lines 44-90), not the Route B passage
changed here - no overlap.
changelog.d/README.md(documentation isexcluded).
Closes st-qmhx