Skip to content

Commit

Permalink
Fix typos in message comments (#199)
Browse files Browse the repository at this point in the history
Signed-off-by: Sean Lin <[email protected]>
Signed-off-by: Eduardo Apolinario <[email protected]>
  • Loading branch information
mayitbeegh authored and eapolinario committed Sep 13, 2023
1 parent 5efad40 commit 6b5b6b9
Show file tree
Hide file tree
Showing 39 changed files with 1,141 additions and 1,140 deletions.
2 changes: 1 addition & 1 deletion flyteidl/gen/pb-go/flyteidl/admin/event.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flyteidl/gen/pb-go/flyteidl/core/catalog.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flyteidl/gen/pb-go/flyteidl/core/compiler.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flyteidl/gen/pb-go/flyteidl/core/identifier.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions flyteidl/gen/pb-go/flyteidl/core/tasks.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions flyteidl/gen/pb-go/flyteidl/core/workflow.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion flyteidl/gen/pb-go/flyteidl/event/event.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 16 additions & 16 deletions flyteidl/gen/pb-go/flyteidl/service/admin.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
},
{
"name": "task_execution_id.task_id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -428,7 +428,7 @@
},
{
"name": "id.task_id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -1076,7 +1076,7 @@
},
{
"name": "id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -1859,7 +1859,7 @@
},
{
"name": "id.task_id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -2285,7 +2285,7 @@
},
{
"name": "id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -2794,7 +2794,7 @@
},
{
"name": "id.resource_type",
"description": "Identifies the specific type of resource that this identifer corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"description": "Identifies the specific type of resource that this identifier corresponds to.\n\n - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects.\nEventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects \nin a similar manner to other Flyte objects",
"in": "query",
"required": false,
"type": "string",
Expand Down Expand Up @@ -3028,7 +3028,7 @@
"INTERRUPTIBLE"
],
"default": "DEFAULT",
"description": "Includes the broad cateogry of machine used for this specific task execution.\n\n - DEFAULT: The default instance class configured for the flyte application platform.\n - INTERRUPTIBLE: The instance class configured for interruptible tasks."
"description": "Includes the broad category of machine used for this specific task execution.\n\n - DEFAULT: The default instance class configured for the flyte application platform.\n - INTERRUPTIBLE: The instance class configured for interruptible tasks."
},
"TaskLogMessageFormat": {
"type": "string",
Expand Down Expand Up @@ -4838,7 +4838,7 @@
"title": "+required"
}
},
"description": "BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at\nruntime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primtives)."
"description": "BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at\nruntime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primitives)."
},
"coreCatalogArtifactTag": {
"type": "object",
Expand All @@ -4865,7 +4865,7 @@
],
"default": "CACHE_DISABLED",
"description": "- CACHE_DISABLED: Used to indicate that caching was disabled\n - CACHE_MISS: Used to indicate that the cache lookup resulted in no matches\n - CACHE_HIT: used to indicate that the associated artifact was a result of a previous execution\n - CACHE_POPULATED: used to indicate that the resultant artifact was added to the cache\n - CACHE_LOOKUP_FAILURE: Used to indicate that cache lookup failed because of an error\n - CACHE_PUT_FAILURE: Used to indicate that cache lookup failed because of an error",
"title": "Indicates the status of CatalogCaching. The reason why this is not embeded in TaskNodeMetadata is, that we may use for other types of nodes as well in the future"
"title": "Indicates the status of CatalogCaching. The reason why this is not embedded in TaskNodeMetadata is, that we may use for other types of nodes as well in the future"
},
"coreCatalogMetadata": {
"type": "object",
Expand Down Expand Up @@ -4943,7 +4943,7 @@
"items": {
"$ref": "#/definitions/coreCompiledTask"
},
"title": "Guaranteed that there will only exist one and only one task with a given id, i.e., every task has a unique id\n+required (atleast 1)"
"title": "Guaranteed that there will only exist one and only one task with a given id, i.e., every task has a unique id\n+required (at least 1)"
}
},
"description": "A Compiled Workflow Closure contains all the information required to start a new execution, or to visualize a workflow\nand its details. The CompiledWorkflowClosure should always contain a primary workflow, that is the main workflow that\nwill being the execution. All subworkflows are denormalized. WorkflowNodes refer to the workflow identifiers of\ncompiled subworkflows."
Expand Down Expand Up @@ -5139,7 +5139,7 @@
"properties": {
"resource_type": {
"$ref": "#/definitions/coreResourceType",
"description": "Identifies the specific type of resource that this identifer corresponds to."
"description": "Identifies the specific type of resource that this identifier corresponds to."
},
"project": {
"type": "string",
Expand Down Expand Up @@ -5355,14 +5355,14 @@
"items": {
"$ref": "#/definitions/coreBinding"
},
"description": "Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface\nmust be fullfilled."
"description": "Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface\nmust be fulfilled."
},
"upstream_node_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "+optional Specifies execution depdendency for this node ensuring it will only get scheduled to run after all its\nupstream nodes have completed. This node will have an implicit depdendency on any node that appears in inputs\nfield."
"description": "+optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its\nupstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs\nfield."
},
"output_aliases": {
"type": "array",
Expand Down Expand Up @@ -5624,7 +5624,7 @@
"description": "Defines a set of bounds (e.g. min/max) within which the task can reliably run. ResourceNames must be unique\nwithin the list."
}
},
"description": "A customizable interface to convey resources requested for a container. This can be interpretted differently for different\ncontainer engines."
"description": "A customizable interface to convey resources requested for a container. This can be interpreted differently for different\ncontainer engines."
},
"coreRetryStrategy": {
"type": "object",
Expand Down Expand Up @@ -5653,7 +5653,7 @@
"description": "+optional It can be used to provide extra information about the runtime (e.g. python, golang... etc.)."
}
},
"description": "Runtime information. This is losely defined to allow for extensibility."
"description": "Runtime information. This is loosely defined to allow for extensibility."
},
"coreScalar": {
"type": "object",
Expand Down Expand Up @@ -5882,7 +5882,7 @@
},
"interface": {
"$ref": "#/definitions/coreTypedInterface",
"description": "A strongly typed interface for the task. This enables others to use this task within a workflow and gauarantees\ncompile-time validation of the workflow to avoid costly runtime failures."
"description": "A strongly typed interface for the task. This enables others to use this task within a workflow and guarantees\ncompile-time validation of the workflow to avoid costly runtime failures."
},
"custom": {
"$ref": "#/definitions/protobufStruct",
Expand Down
Loading

0 comments on commit 6b5b6b9

Please sign in to comment.