Skip to content

docs: improve StateChart docstrings and complete 3.1.0 release notes#609

Merged
fgmacedo merged 2 commits intodevelopfrom
docs/statechart-docstrings-and-release-notes
Apr 3, 2026
Merged

docs: improve StateChart docstrings and complete 3.1.0 release notes#609
fgmacedo merged 2 commits intodevelopfrom
docs/statechart-docstrings-and-release-notes

Conversation

@fgmacedo
Copy link
Copy Markdown
Owner

@fgmacedo fgmacedo commented Apr 3, 2026

Summary

Document missing StateChart members: **kwargs on __init__, model and
history_values instance attributes, events property. Fix typo in
listeners parameter ("provies" -> "provides").

Add missing bugfixes to 3.1.0 release notes: Configuration write-through
(#596) and States.from_enum() in compound/parallel states (#607).
@fgmacedo fgmacedo added this to the 3.1.0 milestone Apr 3, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (386980a) to head (58dfe6c).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop      #609   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           42        42           
  Lines         5025      5027    +2     
  Branches       812       812           
=========================================
+ Hits          5025      5027    +2     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

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

☔ View full report in Codecov by Sentry.
📢 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.

The bug was a silent failure (states not collected), not an error.
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 3, 2026

@fgmacedo fgmacedo merged commit b7a46e5 into develop Apr 3, 2026
14 checks passed
@fgmacedo fgmacedo deleted the docs/statechart-docstrings-and-release-notes branch April 3, 2026 12:52
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