[ignore] Tweaking a couple comments (#75)

flyteidl/gen/pb-go/flyteidl/service/admin.swagger.json

@@ -5416,18 +5416,18 @@
           "description": "Defines how the system should behave when a failure is detected in the workflow execution."
         }
       },
-      "description": "Metadata for the entire workflow. Defines execution behavior that does not change the final outputs of the workflow."
+      "description": "This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not\npercolate down to child entities (like tasks) launched by the workflow."
     },
     "coreWorkflowMetadataDefaults": {
       "type": "object",
       "properties": {
         "interruptible": {
           "type": "boolean",
           "format": "boolean",
-          "description": "Identify whether workflow is interruptible.\nThe value set at the workflow level will be the defualt value used for nodes\nunless explicitly set at the node level."
+          "description": "Whether child nodes of the workflow are interruptible."
         }
       },
-      "description": "Default Workflow Metadata for the entire workflow."
+      "description": "The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to\na workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it\nis only relevant when a task executes. The settings here are the defaults that are passed to all nodes\nunless explicitly overridden at the node layer.\nIf you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be\nadded to both this object and the WorkflowMetadata object above."
     },
     "coreWorkflowNode": {
       "type": "object",

flyteidl/gen/pb-go/flyteidl/service/flyteadmin/api/swagger.yaml

@@ -23395,8 +23395,9 @@ definitions:
         description: "Defines how the system should behave when a failure is detected\
           \ in the workflow execution."
         $ref: "#/definitions/WorkflowMetadataOnFailurePolicy"
-    description: "Metadata for the entire workflow. Defines execution behavior that\
-      \ does not change the final outputs of the workflow."
+    description: "This is workflow layer metadata. These settings are only applicable\
+      \ to the workflow as a whole, and do not\npercolate down to child entities (like\
+      \ tasks) launched by the workflow."
     example:
       on_failure: {}
       quality_of_service:
@@ -23409,10 +23410,15 @@ definitions:
       interruptible:
         type: "boolean"
         format: "boolean"
-        description: "Identify whether workflow is interruptible.\nThe value set at\
-          \ the workflow level will be the defualt value used for nodes\nunless explicitly\
-          \ set at the node level."
-    description: "Default Workflow Metadata for the entire workflow."
+        description: "Whether child nodes of the workflow are interruptible."
+    description: "The difference between these settings and the WorkflowMetadata ones\
+      \ is that these are meant to be passed down to\na workflow's underlying entities\
+      \ (like tasks). For instance, 'interruptible' has no meaning at the workflow\
+      \ layer, it\nis only relevant when a task executes. The settings here are the\
+      \ defaults that are passed to all nodes\nunless explicitly overridden at the\
+      \ node layer.\nIf you are adding a setting that applies to both the Workflow\
+      \ itself, and everything underneath it, it should be\nadded to both this object\
+      \ and the WorkflowMetadata object above."
     example:
       interruptible: true
   coreWorkflowNode:

flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_metadata.go

@@ -9,7 +9,7 @@
 
 package flyteadmin
 
-// Metadata for the entire workflow. Defines execution behavior that does not change the final outputs of the workflow.
+// This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not percolate down to child entities (like tasks) launched by the workflow.
 type CoreWorkflowMetadata struct {
 	// Indicates the runtime priority of workflow executions.
 	QualityOfService *CoreQualityOfService `json:"quality_of_service,omitempty"`

flyteidl/gen/pb-go/flyteidl/service/flyteadmin/model_core_workflow_metadata_defaults.go

@@ -9,8 +9,8 @@
 
 package flyteadmin
 
-// Default Workflow Metadata for the entire workflow.
+// The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it is only relevant when a task executes. The settings here are the defaults that are passed to all nodes unless explicitly overridden at the node layer. If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be added to both this object and the WorkflowMetadata object above.
 type CoreWorkflowMetadataDefaults struct {
-	// Identify whether workflow is interruptible. The value set at the workflow level will be the defualt value used for nodes unless explicitly set at the node level.
+	// Whether child nodes of the workflow are interruptible.
 	Interruptible bool `json:"interruptible,omitempty"`
 }

flyteidl/gen/pb-protodoc/flyteidl/core/workflow.proto.rst

@@ -339,9 +339,10 @@ branch_node
 flyteidl.core.WorkflowMetadata
 ------------------------------
 
-`[flyteidl.core.WorkflowMetadata proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L130>`_
+`[flyteidl.core.WorkflowMetadata proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L131>`_
 
-Metadata for the entire workflow. Defines execution behavior that does not change the final outputs of the workflow.
+This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not
+percolate down to child entities (like tasks) launched by the workflow.
 
 .. code-block:: json
 
@@ -368,7 +369,7 @@ on_failure
 Enum flyteidl.core.WorkflowMetadata.OnFailurePolicy
 ---------------------------------------------------
 
-`[flyteidl.core.WorkflowMetadata.OnFailurePolicy proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L135>`_
+`[flyteidl.core.WorkflowMetadata.OnFailurePolicy proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L136>`_
 
 Failure Handling Strategy
 
@@ -395,9 +396,14 @@ FAIL_AFTER_EXECUTABLE_NODES_COMPLETE
 flyteidl.core.WorkflowMetadataDefaults
 --------------------------------------
 
-`[flyteidl.core.WorkflowMetadataDefaults proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L153>`_
+`[flyteidl.core.WorkflowMetadataDefaults proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L159>`_
 
-Default Workflow Metadata for the entire workflow.
+The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to
+a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it
+is only relevant when a task executes. The settings here are the defaults that are passed to all nodes
+unless explicitly overridden at the node layer.
+If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be
+added to both this object and the WorkflowMetadata object above.
 
 .. code-block:: json
 
@@ -408,9 +414,7 @@ Default Workflow Metadata for the entire workflow.
 .. _api_field_flyteidl.core.WorkflowMetadataDefaults.interruptible:
 
 interruptible
-  (`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Identify whether workflow is interruptible.
-  The value set at the workflow level will be the defualt value used for nodes
-  unless explicitly set at the node level.
+  (`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) Whether child nodes of the workflow are interruptible.
 
 
 
@@ -420,7 +424,7 @@ interruptible
 flyteidl.core.WorkflowTemplate
 ------------------------------
 
-`[flyteidl.core.WorkflowTemplate proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L162>`_
+`[flyteidl.core.WorkflowTemplate proto] <https://github.com/lyft/flyteidl/blob/master/protos/flyteidl/core/workflow.proto#L166>`_
 
 Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable,
 directed acyclic graph.

flyteidl/gen/pb_python/flyteidl/service/flyteadmin/flyteadmin/models/core_workflow_metadata_defaults.py

@@ -51,7 +51,7 @@ def __init__(self, interruptible=None):  # noqa: E501
     def interruptible(self):
         """Gets the interruptible of this CoreWorkflowMetadataDefaults.  # noqa: E501
 
-        Identify whether workflow is interruptible. The value set at the workflow level will be the defualt value used for nodes unless explicitly set at the node level.  # noqa: E501
+        Whether child nodes of the workflow are interruptible.  # noqa: E501
 
         :return: The interruptible of this CoreWorkflowMetadataDefaults.  # noqa: E501
         :rtype: bool
@@ -62,7 +62,7 @@ def interruptible(self):
     def interruptible(self, interruptible):
         """Sets the interruptible of this CoreWorkflowMetadataDefaults.
 
-        Identify whether workflow is interruptible. The value set at the workflow level will be the defualt value used for nodes unless explicitly set at the node level.  # noqa: E501
+        Whether child nodes of the workflow are interruptible.  # noqa: E501
 
         :param interruptible: The interruptible of this CoreWorkflowMetadataDefaults.  # noqa: E501
         :type: bool

flyteidl/protos/flyteidl/core/workflow.proto

@@ -127,7 +127,8 @@ message Node {
     }
 }
 
-// Metadata for the entire workflow. Defines execution behavior that does not change the final outputs of the workflow.
+// This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not
+// percolate down to child entities (like tasks) launched by the workflow.
 message WorkflowMetadata {
     // Indicates the runtime priority of workflow executions. 
     QualityOfService quality_of_service = 1;
@@ -150,11 +151,14 @@ message WorkflowMetadata {
     OnFailurePolicy on_failure = 2;
 }
 
-// Default Workflow Metadata for the entire workflow.
+// The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to
+// a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it
+// is only relevant when a task executes. The settings here are the defaults that are passed to all nodes
+// unless explicitly overridden at the node layer.
+// If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be
+// added to both this object and the WorkflowMetadata object above.
 message WorkflowMetadataDefaults {
-    // Identify whether workflow is interruptible.
-    // The value set at the workflow level will be the defualt value used for nodes
-    // unless explicitly set at the node level.
+    // Whether child nodes of the workflow are interruptible.
     bool interruptible = 1;
 }