Skip to content

Commit d443950

Browse files
committed
📄 docs: update comment on stage module.
1 parent 6b70111 commit d443950

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

src/ddeutil/workflow/stages.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,13 +251,17 @@ def handler_execute(
251251
f"[STAGE]: Handler {to_train(self.__class__.__name__)}: "
252252
f"{self.name!r}."
253253
)
254+
255+
# NOTE: Show the description of this stage before execution.
254256
if self.desc:
255257
result.trace.debug(f"[STAGE]: Description:||{self.desc}||")
256258

259+
# VALIDATE: Checking stage condition before execution.
257260
if self.is_skipped(params):
258261
raise StageSkipError(
259262
f"Skip because condition {self.condition} was valid."
260263
)
264+
261265
# NOTE: Start call wrapped execution method that will use custom
262266
# execution before the real execution from inherit stage model.
263267
result_caught: Result = self._execute(
@@ -513,11 +517,14 @@ async def handler_axecute(
513517
f"[STAGE]: Handler {to_train(self.__class__.__name__)}: "
514518
f"{self.name!r}."
515519
)
520+
521+
# NOTE: Show the description of this stage before execution.
516522
if self.desc:
517523
await result.trace.adebug(
518524
f"[STAGE]: Description:||{self.desc}||"
519525
)
520526

527+
# VALIDATE: Checking stage condition before execution.
521528
if self.is_skipped(params=params):
522529
raise StageSkipError(
523530
f"Skip because condition {self.condition} was valid."

0 commit comments

Comments
 (0)