Merge pull request #56 from alphatwirl/dev

Update the state diagram in docstring
alphatwirl · Jun 30, 2024 · b03b7d7 · b03b7d7
2 parents cd3d92b + a477058
commit b03b7d7
Showing 1 changed file with 19 additions and 28 deletions.
diff --git a/atpbar/machine.py b/atpbar/machine.py
@@ -10,36 +10,27 @@
 
 State Diagram:
 
-     .----------------------------------------------.
-     |                                              |
-     |               .-------------.                |
-     |    .--------->|   Initial   |                |
-     |    |          '-------------'                |
-     |    |                 | prepare_reporter()    |
-     |  shutdown()          | flush()               |
-     |    |                 v                       |
-     |    |          .-------------.                |
-     |    '----------|   Active    |<---------.     |
-     |               '-------------'          |     |
-     |                      |on_yielded()     |     |
-     |                      |                 |     |
-     |                      v          on_resumed() |
-     |               .-------------.          |     |
-     |               |   Yielded   |----------'     |
-     |               '-------------'                |
-     '----------------------------------------------'
-              |                               |
-              |--------------------------.    |-------------.
-         register_reporter()             |    | disable()   |
-              |                          |    |             |
-              v                          |    v             |
-        .-------------.              .-------------.        |
-        | Registered  |              |  Disabled   |        |
-        '-------------'              '-------------'        |
-              |                                             |
-              '---------------------------------------------'
+     .-------------.        shutdown() 
+     |   Initial   |<------------------*
+     '-------------'
+            | prepare_reporter()
+            | flush()
+            v 
+     .-------------.     on_resumed() .-------------.
+     |   Active    |<---------------->|   Yielded   |
+     '-------------' on_yielded()     '-------------'
 
 
+        register_reporter()    .-------------.
+      *----------------------->| Registered  |
+                               '-------------'
+
+
+         disable()             .-------------.
+      *----------------------->|  Disabled   |
+                               '-------------'
+
+NOTE: In a forked sub-process, the state starts from the same state as the parent process.
 '''