Merge pull request #1208 from sarahcstringer/improve-component-descriptions

UladzislauK-Writer · web-flow · commit c3982b30007f · 2025-11-24T09:31:21.000+01:00
chore: Clean up user-facing strings in blueprint blocks.
diff --git a/src/writer/blocks/addtostatelist.py b/src/writer/blocks/addtostatelist.py
@@ -29,12 +29,12 @@ def register(cls, type: str):
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the function doesn't raise an Exception.",
+                        "description": "The item was added to the list.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error adding the item to the list.",
                         "style": "error",
                     },
                 },
diff --git a/src/writer/blocks/changepage.py b/src/writer/blocks/changepage.py
@@ -30,7 +30,7 @@ def register(cls, type: str):
                         },
                         "error": {
                             "name": "Error",
-                            "description": "The event handler execution wasn't successful.",
+                            "description": "There was an error changing the page.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/code.py b/src/writer/blocks/code.py
@@ -51,12 +51,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "The event handler execution was successful.",
+                            "description": "The code executed successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "The event handler execution wasn't successful.",
+                            "description": "There was an error executing the code.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/foreach.py b/src/writer/blocks/foreach.py
@@ -18,7 +18,7 @@ def register(cls, type: str):
                     "fields": {
                         "items": {
                             "name": "Items",
-                            "desc": "The item value will be passed in the execution environment and will be available at @{item}, its id at @{itemId}. You can use either a list or a dictionary.",
+                            "desc": "The item value will be passed in the execution environment. It will be available at @{item}, and its ID at @{itemId}. You can use either a list or a dictionary.",
                             "default": "[]",
                             "init": '["France", "Poland"]',
                             "type": "Object",
diff --git a/src/writer/blocks/httprequest.py b/src/writer/blocks/httprequest.py
@@ -15,7 +15,7 @@ def register(cls, type: str):
                 baseType="blueprints_node",
                 writer={
                     "name": "HTTP request",
-                    "description": "Sends a HTTP request to an API endpoint. Used to fetch data or send data.",
+                    "description": "Sends an HTTP request to an API endpoint. Used to fetch or send data.",
                     "category": "Other",
                     "fields": {
                         "method": {
diff --git a/src/writer/blocks/logmessage.py b/src/writer/blocks/logmessage.py
@@ -27,12 +27,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "The request was successful.",
+                            "description": "The message was logged successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "The blueprint was executed successfully.",
+                            "description": "There was an error logging the message.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/returnvalue.py b/src/writer/blocks/returnvalue.py
@@ -24,12 +24,12 @@ def register(cls, type: str):
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the function doesn't raise an Exception.",
+                        "description": "The value was returned successfully.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error returning the value.",
                         "style": "error",
                     },
                 },
diff --git a/src/writer/blocks/runblueprint.py b/src/writer/blocks/runblueprint.py
@@ -26,7 +26,7 @@ def register(cls, type: str):
                         },
                         "payload": {
                             "name": "Payload",
-                            "desc": "The value specified will be available using the template syntax i.e. @{payload}",
+                            "desc": "The value specified will be available using the template syntax, e.g. @{payload}.",
                             "default": "{}",
                             "type": "Text",
                             "control": "Textarea",
@@ -40,7 +40,7 @@ def register(cls, type: str):
                         },
                         "error": {
                             "name": "Error",
-                            "description": "The blueprint was executed successfully.",
+                            "description": "The blueprint execution failed.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/setstate.py b/src/writer/blocks/setstate.py
@@ -19,7 +19,7 @@ def register(cls, type: str):
                         "element": {
                             "name": "Link Variable",
                             "type": "Binding",
-                            "desc": "Set the variable here and use it across your agent",
+                            "desc": "Set the variable here and use it across your agent.",
                         },
                         "valueType": {
                             "name": "Value type",
@@ -36,12 +36,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The state was updated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error updating the state.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writeraddchatmessage.py b/src/writer/blocks/writeraddchatmessage.py
@@ -75,12 +75,12 @@ def register(cls, type: str):
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the function doesn't raise an Exception.",
+                        "description": "The message was added to the conversation.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error adding the message.",
                         "style": "error",
                     },
                 },
diff --git a/src/writer/blocks/writeraddtokg.py b/src/writer/blocks/writeraddtokg.py
@@ -52,12 +52,12 @@ def register(cls, type: str):
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the execution was successful.",
+                        "description": "Content was added to the knowledge graph.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error adding content to the knowledge graph.",
                         "style": "error",
                     },
                 },
diff --git a/src/writer/blocks/writeraskkg.py b/src/writer/blocks/writeraskkg.py
@@ -63,7 +63,7 @@ def register(cls, type: str):
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error answering the question.",
                         "style": "error"
                     }
                 }
diff --git a/src/writer/blocks/writerchat.py b/src/writer/blocks/writerchat.py
@@ -47,12 +47,12 @@ def register(cls, type: str):
                         },
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The reply was generated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating the reply.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerchatreply.py b/src/writer/blocks/writerchatreply.py
@@ -147,12 +147,12 @@ def register(cls, type: str):
                         },
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The reply was generated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating the reply.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerchatreplywithtoolconfig.py b/src/writer/blocks/writerchatreplywithtoolconfig.py
@@ -160,12 +160,12 @@ def register(cls, type: str):
                         },
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The reply was generated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating the reply.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerclassification.py b/src/writer/blocks/writerclassification.py
@@ -28,7 +28,7 @@ def register(cls, type: str):
                             "name": "Categories",
                             "type": "Key-Value",
                             "default": "{}",
-                            "desc": "The keys should be the categories you want to classify the text in, for example 'valid' and 'invalid', and the values the criteria for each category. Category names should contain only letters of the English alphabet, digits, underscores and spaces.",
+                            "desc": "The keys should be the categories you want to classify the text into, for example 'valid' and 'invalid', and the values are the criteria for each category. Category names should contain only letters of the English alphabet, digits, underscores, and spaces.",
                         },
                         "additionalContext": {
                             "name": "Additional context",
@@ -41,7 +41,7 @@ def register(cls, type: str):
                         "category": {"field": "categories", "style": "dynamic"},
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error classifying the text.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writercompletion.py b/src/writer/blocks/writercompletion.py
@@ -43,12 +43,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "Text was generated successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating text.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerfileapi.py b/src/writer/blocks/writerfileapi.py
@@ -35,7 +35,7 @@ def register(cls, type: str):
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error uploading the files.",
                         "style": "error"
                     }
                 }
diff --git a/src/writer/blocks/writerinitchat.py b/src/writer/blocks/writerinitchat.py
@@ -52,12 +52,12 @@ def register(cls, type: str):
                 "outs": {
                     "success": {
                         "name": "Success",
-                        "description": "If the function doesn't raise an Exception.",
+                        "description": "The conversation was initialized.",
                         "style": "success",
                     },
                     "error": {
                         "name": "Error",
-                        "description": "If the function raises an Exception.",
+                        "description": "There was an error initializing the conversation.",
                         "style": "error",
                     },
                 },
diff --git a/src/writer/blocks/writerkeyvaluestorage.py b/src/writer/blocks/writerkeyvaluestorage.py
@@ -16,7 +16,7 @@ def register(cls, type: str):
                 baseType="blueprints_node",
                 writer={
                     "name": "Key-Value Storage",
-                    "description": "Allows to store data between sessions. Uses unique keys (names) to identify the data. Keys can only contain alphanumeric characters, underscores and hyphens",
+                    "description": "Stores data between sessions. Uses unique keys (names) to identify the data. Keys can only contain alphanumeric characters, underscores, and hyphens.",
                     "category": "Writer",
                     "fields": {
                         "action": {
diff --git a/src/writer/blocks/writernocodeapp.py b/src/writer/blocks/writernocodeapp.py
@@ -13,7 +13,7 @@ def register(cls, type: str):
                 baseType="blueprints_node",
                 writer={
                     "name": "AI Studio agent",
-                    "description": "Runs an Writer AI Studio agent app by ID.",
+                    "description": "Runs a Writer AI Studio agent app by ID.",
                     "category": "Writer",
                     "fields": {
                         "appId": {
@@ -30,12 +30,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the execution was successful.",
+                            "description": "The agent ran successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error running the agent.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerparsepdf.py b/src/writer/blocks/writerparsepdf.py
@@ -38,12 +38,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the execution was successful.",
+                            "description": "The PDF was parsed successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error parsing the PDF.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerstructuredoutput.py b/src/writer/blocks/writerstructuredoutput.py
@@ -17,7 +17,7 @@ def register(cls, type: str):
                 baseType="blueprints_node",
                 writer={
                     "name": "Structured output",
-                    "description": "Allows to define a JSON response format, which the agent will use to structure its output.",
+                    "description": "Defines a JSON response format that the agent will use to structure its output.",
                     "category": "Writer",
                     "fields": {
                         "prompt": {"name": "Prompt", "type": "Text", "control": "Textarea", "desc": "Description of a JSON object to be created."},
@@ -46,12 +46,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The structured output was generated.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error generating the output.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writertoolcalling.py b/src/writer/blocks/writertoolcalling.py
@@ -50,12 +50,12 @@ def register(cls, type: str):
                         },
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The task was completed successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error completing the task.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writervision.py b/src/writer/blocks/writervision.py
@@ -58,12 +58,12 @@ def register(cls, type: str):
                     "outs": {
                         "success": {
                             "name": "Success",
-                            "description": "If the function doesn't raise an Exception.",
+                            "description": "The image was analyzed successfully.",
                             "style": "success",
                         },
                         "error": {
                             "name": "Error",
-                            "description": "If the function raises an Exception.",
+                            "description": "There was an error analyzing the image.",
                             "style": "error",
                         },
                     },
diff --git a/src/writer/blocks/writerwebsearch.py b/src/writer/blocks/writerwebsearch.py
