Skip to content

Commit 34ff47e

Browse files
committed
docs(phase_actors): add docstrings
1 parent cfdce5f commit 34ff47e

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

leapp/workflows/phaseactors.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ def __init__(self, actors, stage):
77
self._actors = actors
88
self._consumes = set()
99
self._produces = set()
10-
self._messages = {}
10+
self._messages = {} # Information about message producers for topoplogical sorting
1111

1212
for actor in self._actors:
1313
self._consumes.update(actor.consumes)
@@ -22,21 +22,26 @@ def __init__(self, actors, stage):
2222

2323
@property
2424
def initial(self):
25+
""" Tuple of messages that are not consumed by any actor. """
2526
return tuple(self._initial)
2627

2728
@property
2829
def actors(self):
30+
""" Tuple of actors in the execution order. """
2931
return tuple(self._actors)
3032

3133
@property
3234
def consumes(self):
35+
""" Tuple containing all messages consumed by some actor. """
3336
return tuple(self._consumes)
3437

3538
@property
3639
def produces(self):
40+
""" Tuple containing all messages produced by some actor. """
3741
return tuple(self._produces)
3842

3943
def _sort(self):
44+
""" Perform topological sort of the actor dependency graph for this phase, producing execution order. """
4045
actors, self._actors = list(self._actors), ()
4146
while actors:
4247
scheduled = []

0 commit comments

Comments
 (0)