Skip to content

docs: polish the 3.2.2 release notes and the pages they link to - #682

Merged
fgmacedo merged 1 commit into
mainfrom
fgmacedo/docs-322-release-notes
Oct 13, 2026
Merged

fgmacedo merged 1 commit into
mainfrom
fgmacedo/docs-322-release-notes

Conversation

@fgmacedo

@fgmacedo fgmacedo commented Oct 13, 2026 •

Copy link
Copy Markdown
Owner

Why

Since v3.2.1, seven PRs each appended a section to docs/releases/3.2.2.md. A read-only audit of git log v3.2.1..origin/main found 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

Refs #643, #644, #646, #649, #651, #653, #654, #655

Evidence

$ timeout 120 uv run pytest docs/releases/3.2.2.md docs/events.md docs/statechart.md docs/processing_model.md docs/diagram.md --no-cov -q
5 passed
$ timeout 180 uv run pytest -n 4
2664 passed, 25 skipped, 44 xfailed
$ uv run sphinx-build -q docs docs/_build/html 2>&1 | grep -ci warning   # main vs branch
48 / 48   (none in the changed files)

Behavior claims were checked by running the same probe scripts against git archive v3.2.1 statemachine (via PYTHONPATH) and against this branch. For example, raise_() on a StateMachine from outside: None before, TransitionNotAllowed now. 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 declared internal=True now raises InvalidDefinition), now listed, and the delay+internal doctest now checks the exception message (-IGNORE_EXCEPTION_DETAIL).

Not verified

@fgmacedo fgmacedo added this to the 3.2.2 milestone Oct 13, 2026
@fgmacedo
fgmacedo force-pushed the fgmacedo/docs-322-release-notes branch from 331c5e4 to 053e24f Compare October 13, 2026 20:24
@codecov

codecov Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (38968c1) to head (feafad4).

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           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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
fgmacedo force-pushed the fgmacedo/docs-322-release-notes branch from 053e24f to feafad4 Compare October 13, 2026 21:09
@sonarqubecloud

Copy link
Copy Markdown

@fgmacedo
fgmacedo merged commit 0be2460 into main Oct 13, 2026
14 checks passed
@fgmacedo
fgmacedo deleted the fgmacedo/docs-322-release-notes branch October 13, 2026 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant