From 326c0bd9383101da2fb37a852da4589c17471dc7 Mon Sep 17 00:00:00 2001 From: nikki everett Date: Wed, 10 Apr 2024 09:38:32 -0500 Subject: [PATCH 1/3] copy changes over from flytesnacks#1553 Signed-off-by: nikki everett --- docs/user_guide/data_types_and_io/dataclass.md | 3 +++ docs/user_guide/data_types_and_io/index.md | 3 +-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/user_guide/data_types_and_io/dataclass.md b/docs/user_guide/data_types_and_io/dataclass.md index fdb9f1d992..8cf4449e21 100644 --- a/docs/user_guide/data_types_and_io/dataclass.md +++ b/docs/user_guide/data_types_and_io/dataclass.md @@ -35,6 +35,9 @@ If you're using Flytekit version below v1.10, you'll need to decorate with `@dat `from dataclass_json import dataclass_json` instead of inheriting from Mashumaro's `DataClassJSONMixin`. ::: +If you're using Flytekit version >= v1.11.1, you don't need to decorate with `@dataclass_json` or +inherit from Mashumaro's `DataClassJSONMixin`. + To begin, import the necessary dependencies. ```{code-cell} diff --git a/docs/user_guide/data_types_and_io/index.md b/docs/user_guide/data_types_and_io/index.md index f55aec69b4..d03df92804 100644 --- a/docs/user_guide/data_types_and_io/index.md +++ b/docs/user_guide/data_types_and_io/index.md @@ -99,8 +99,7 @@ Here's a breakdown of these mappings: * - ``@dataclass`` - ``Struct`` - Automatic - - The class should be a pure value class that inherits from Mashumaro's DataClassJSONMixin, - and be annotated with the ``@dataclass`` decorator. + - The class should be a pure value class annotated with the ``@dataclass`` decorator. * - ``np.ndarray`` - File - Automatic From 1c74984aebc5a51fe31c578265baf865e2d31828 Mon Sep 17 00:00:00 2001 From: nikki everett Date: Thu, 11 Apr 2024 14:25:55 -0500 Subject: [PATCH 2/3] fix formatting Signed-off-by: nikki everett --- docs/user_guide/data_types_and_io/dataclass.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/data_types_and_io/dataclass.md b/docs/user_guide/data_types_and_io/dataclass.md index 8cf4449e21..7bdaee0385 100644 --- a/docs/user_guide/data_types_and_io/dataclass.md +++ b/docs/user_guide/data_types_and_io/dataclass.md @@ -33,10 +33,10 @@ to serialize and deserialize dataclasses. :::{important} If you're using Flytekit version below v1.10, you'll need to decorate with `@dataclass_json` using `from dataclass_json import dataclass_json` instead of inheriting from Mashumaro's `DataClassJSONMixin`. -::: If you're using Flytekit version >= v1.11.1, you don't need to decorate with `@dataclass_json` or inherit from Mashumaro's `DataClassJSONMixin`. +::: To begin, import the necessary dependencies. From f9de0a09287b913986fb2d64bf2f67f510c9d8d6 Mon Sep 17 00:00:00 2001 From: nikki everett Date: Thu, 11 Apr 2024 14:43:50 -0500 Subject: [PATCH 3/3] fix 404 error Signed-off-by: nikki everett --- .../flyte_project_components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started_with_workflow_development/flyte_project_components.md b/docs/getting_started_with_workflow_development/flyte_project_components.md index 8c24946aad..998aeed292 100644 --- a/docs/getting_started_with_workflow_development/flyte_project_components.md +++ b/docs/getting_started_with_workflow_development/flyte_project_components.md @@ -32,7 +32,7 @@ manage your project's Python requirements. ````{dropdown} See requirements.txt -```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/simple-example/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt +```{rli} https://raw.githubusercontent.com/flyteorg/flytekit-python-template/main/basic-template-imagespec/%7B%7Bcookiecutter.project_name%7D%7D/requirements.txt :caption: requirements.txt ```