docs: add explanation for action return values#378
docs: add explanation for action return values#378fgmacedo merged 2 commits intofgmacedo:developfrom
Conversation
| >>> sm = ExampleStateMachine() | ||
|
|
||
| >>> sm.loop() | ||
| >>> ['Before loop', None, 'On loop'] |
There was a problem hiding this comment.
This line broke the automated tests.
/home/runner/work/python-statemachine/python-statemachine/docs/actions.md:370: DocTestFailure
362 ... pass
363 ...
364 ... def on_loop(self):
365 ... return "On loop"
366 ...
367
368 >>> sm = ExampleStateMachine()
369
370 >>> sm.loop()
371 >>> ['Before loop', None, 'On loop']
Expected nothing
Got:
['Before loop', None, 'On loop']Just removing the prompt >>> should fix the issue.
| >>> ['Before loop', None, 'On loop'] | |
| ['Before loop', None, 'On loop'] |
There was a problem hiding this comment.
Interesting, I thought pre-commit would run for the doc test. Well I think we're good here.
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## develop #378 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 976 976
Branches 161 161
=========================================
Hits 976 976
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
|
Kudos, SonarCloud Quality Gate passed!
|
2 participants
Closes #377 .