Re-apply changes to dataclass docs from flytesnacks#1553 (#5211)

* copy changes over from flytesnacks#1553 Signed-off-by: nikki everett <[email protected]> * fix formatting Signed-off-by: nikki everett <[email protected]> * fix 404 error Signed-off-by: nikki everett <[email protected]> --------- Signed-off-by: nikki everett <[email protected]>
flyteorg · Apr 12, 2024 · b36556e · b36556e
1 parent 734d6f3
commit b36556e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/user_guide/data_types_and_io/dataclass.md b/docs/user_guide/data_types_and_io/dataclass.md
@@ -33,6 +33,9 @@ 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.

diff --git 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