Update Workflow Steps documents

Author: seratch

docs/_steps/adding_editing_workflow_step.md

@@ -28,34 +28,21 @@ def edit(ack, step, configure):
             "element": {
                 "type": "plain_text_input",
                 "action_id": "name",
-                "placeholder": {
-                    "type": "plain_text",
-                    "text": "Add a task name",
-                },
-            },
-            "label": {
-                "type": "plain_text",
-                "text": "Task name",
+                "placeholder": {"type": "plain_text", "text": "Add a task name"},
             },
+            "label": {"type": "plain_text", "text": "Task name"},
         },
         {
             "type": "input",
             "block_id": "task_description_input",
             "element": {
                 "type": "plain_text_input",
                 "action_id": "description",
-                "placeholder": {
-                    "type": "plain_text",
-                    "text": "Add a task description",
-            },
-            },
-            "label": {
-                "type": "plain_text",
-                "text": "Task description",
+                "placeholder": {"type": "plain_text", "text": "Add a task description"},
             },
+            "label": {"type": "plain_text", "text": "Task description"},
         },
     ]
-
     configure(blocks=blocks)
 
 ws = WorkflowStep(
@@ -64,6 +51,5 @@ ws = WorkflowStep(
     save=save,
     execute=execute,
 )
-
 app.step(ws)
 ```

docs/_steps/creating_workflow_step.md

@@ -18,6 +18,7 @@ After instantiating a `WorkflowStep`, you can pass it into `app.step()`. Behind
 </div>
 
 ```python
+import os
 from slack_bolt import App
 from slack_bolt.workflows.step import WorkflowStep
 
@@ -27,14 +28,22 @@ app = App(
     signing_secret=os.environ.get("SLACK_SIGNING_SECRET")
 )
 
+def edit(ack, step, configure):
+    pass
+
+def save(ack, view, update):
+    pass
+
+def execute(step, complete, fail):
+    pass
+
 # Create a new WorkflowStep instance
 ws = WorkflowStep(
     callback_id="add_task",
     edit=edit,
     save=save,
     execute=execute,
 )
-
 # Pass Step to set up listeners
 app.step(ws)
 ```

docs/_steps/executing_workflow_steps.md

@@ -18,20 +18,17 @@ Within the `execute` callback, your app must either call `complete()` to indicat
 ```python
 def execute(step, complete, fail):
     inputs = step["inputs"]
-
+    # if everything was successful
     outputs = {
         "task_name": inputs["task_name"]["value"],
         "task_description": inputs["task_description"]["value"],
     }
+    complete(outputs=outputs)
 
+    # if something went wrong
     error = {
         "message": "Just testing step failure!"
     }
-
-    # if everything was successful
-    complete(outputs=outputs)
-
-    # if something went wrong
     fail(error=error)
 
 ws = WorkflowStep(
@@ -40,6 +37,5 @@ ws = WorkflowStep(
     save=save,
     execute=execute,
 )
-
 app.step(ws)
 ```

docs/_steps/saving_workflow_step.md

@@ -29,14 +29,9 @@ def save(ack, view, update):
     task_description = values["task_description_input"]["description"]
 
     inputs = {
-        "task_name": { 
-            "value": task_name.value 
-        },
-        "task_description": { 
-            "value": task_description.value 
-        },
+        "task_name": {"value": task_name.value},
+        "task_description": {"value": task_description.value}
     }
-
     outputs = [
         {
             "type": "text",
@@ -49,15 +44,13 @@ def save(ack, view, update):
             "label": "Task description",
         }
     ]
-
-    update(inputs=inputs, outputs=outputs);
+    update(inputs=inputs, outputs=outputs)
 
 ws = WorkflowStep(
     callback_id="add_task",
     edit=edit,
     save=save,
     execute=execute,
 )
-
 app.step(ws)
 ```