Repository navigation
docs: polish the 3.2.2 release notes and the pages they link to - #682
Merged
Merged
Conversation
fgmacedo
force-pushed
the
fgmacedo/docs-322-release-notes
branch
from
October 13, 2026 20:24
331c5e4 to
053e24f
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #682 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 53 53
Lines 5816 5816
Branches 926 926
=========================================
Hits 5816 5816
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Open the notes with a summary and a list of the behavior changes to check when upgrading, group the fixes by theme, and cite the issue and the PR of every entry. Add the missing entries for #650 and the GraphvizError exception change, the rejection of nested callbacks named like an event, and the events dropped after a top-level final state. Document Event(delay=..., internal=...) in the events page, the declared delay in the delayed events section, and the queue being discarded on termination in the processing model. Signed-off-by: Fernando Macedo <fgmacedo@gmail.com>
fgmacedo
force-pushed
the
fgmacedo/docs-322-release-notes
branch
from
October 13, 2026 21:09
053e24f to
feafad4
Compare
|
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
Since
v3.2.1, seven PRs each appended a section todocs/releases/3.2.2.md. A read-only audit ofgit log v3.2.1..origin/mainfound 8 gaps: a missing entry for #650, undocumented exception and event-listing changes, uncredited contributors, and no upgrade checklist for a patch release that changes behavior.What changes
main.GraphvizErrorreplaces pydot'sAssertionError/FileNotFoundError, and the entry says what to catch now.raise_()andsend(..., internal=True)from outside a step.raise_()on an event declared with adelay.TriggerData.execution_timeis on the monotonic clock.delay/internalsections become one, and the three fix: keep event order, measure delays on the monotonic clock, cancel by marking #665 sections become one.Beaconsis no longer defined twice.events.mddocumentsEvent(delay=..., internal=...)and nested-body declarations.statechart.mdcovers declared delays.processing_model.mdstates that the queue is discarded on termination.diagram.mdgains adiagram-graphviz-errorsanchor, what to catch, and the relative zoom link.Refs #643, #644, #646, #649, #651, #653, #654, #655
Evidence
Behavior claims were checked by running the same probe scripts against
git archive v3.2.1 statemachine(viaPYTHONPATH) and against this branch. For example,raise_()on aStateMachinefrom outside:Nonebefore,TransitionNotAllowednow. Four rounds of adversarial review (the fourth after the rebase) read the notes as a user upgrading from 3.2.1. The fourth found one missing upgrade item (send(..., delay=...)on an event declaredinternal=Truenow raisesInvalidDefinition), now listed, and the delay+internal doctest now checks the exception message (-IGNORE_EXCEPTION_DETAIL).Not verified
GraphvizNotFoundError); the notes describe their final behavior, checked with probes on sync and async, but the async drop scenarios were exercised only withasyncio.gatherin a single event loop.{class}roles forInvalidDefinitionandStateMachineErrorrender unlinked, because neither class is autodoc'd. This pattern predates this PR.