From 95fd4efd0613ed5caa3bc206dfc36c6cc9b2441e Mon Sep 17 00:00:00 2001 From: James Onnen Date: Tue, 3 Dec 2024 13:20:37 -0800 Subject: [PATCH 1/2] Update Enum.yaml to add FromName and FromValue to docs Adds Enum:FromName and Enum:FromValue calls --- .../reference/engine/datatypes/Enum.yaml | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/content/en-us/reference/engine/datatypes/Enum.yaml b/content/en-us/reference/engine/datatypes/Enum.yaml index aa60f51d3..a85d3a631 100644 --- a/content/en-us/reference/engine/datatypes/Enum.yaml +++ b/content/en-us/reference/engine/datatypes/Enum.yaml @@ -27,5 +27,29 @@ methods: code_samples: [] tags: [] deprecation_message: '' + - name: Enum:FromName + summary: | + Convert a enum name to an enum + description: | + Returns either the converted Enum, or nil + parameters: + returns: + - type: Enum | nil + summary: 'Converts from string to enum' + code_samples: [] + tags: [] + deprecation_message: '' + - name: Enum:FromValue + summary: | + Convert an enum value to an enum + description: | + Returns either the converted Enum, or nil + parameters: + returns: + - type: Enum | nil + summary: 'Converts from a value to enum' + code_samples: [] + tags: [] + deprecation_message: '' functions: math_operations: From e3a5512020283198666b84e890bf09a41bfc0e06 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Tue, 3 Dec 2024 12:27:37 -1000 Subject: [PATCH 2/2] Apply suggestions from code review --- content/en-us/reference/engine/datatypes/Enum.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en-us/reference/engine/datatypes/Enum.yaml b/content/en-us/reference/engine/datatypes/Enum.yaml index a85d3a631..a058ad67d 100644 --- a/content/en-us/reference/engine/datatypes/Enum.yaml +++ b/content/en-us/reference/engine/datatypes/Enum.yaml @@ -29,25 +29,25 @@ methods: deprecation_message: '' - name: Enum:FromName summary: | - Convert a enum name to an enum + Converts an enum name to an `Datatype.Enum`. description: | - Returns either the converted Enum, or nil + Returns either the converted `Datatype.Enum` or `nil`. parameters: returns: - type: Enum | nil - summary: 'Converts from string to enum' + summary: '' code_samples: [] tags: [] deprecation_message: '' - name: Enum:FromValue summary: | - Convert an enum value to an enum + Converts an enum value to an `Datatype.Enum`. description: | - Returns either the converted Enum, or nil + Returns either the converted `Datatype.Enum` or `nil`. parameters: returns: - type: Enum | nil - summary: 'Converts from a value to enum' + summary: '' code_samples: [] tags: [] deprecation_message: ''