Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Explicitly note that nested dataclasses are not supported in the type system #3328

Closed
2 tasks done
Tracked by #5783
alex-dr opened this issue Feb 10, 2023 · 3 comments
Closed
2 tasks done
Tracked by #5783
Labels
backlogged For internal use. Reserved for contributor team workflow. documentation Improvements or additions to documentation hacktoberfest

Comments

@alex-dr
Copy link

alex-dr commented Feb 10, 2023

Description

In #3110 it was noted that nested dataclasses are not actually supported, and the docs are not very explicit about that.

Given I've gone down a couple rabbit holes related to this (another one related to enum types in doubly-nested dataclasses...), it would be worth making the docs more clear.

In my case, it would have helped to update the comment in this table to mention that nested dataclasses (and I'm not sure what else) are not supported.

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@alex-dr alex-dr added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Feb 10, 2023
@cosmicBboy
Copy link
Contributor

Note: a nuance here is the the Flytekit SDK supports nested dataclasses, but the FlyteIDL type system will lose all the type information in the nested dataclasses, only preserving the types of the top-most dataclass.

@neverett neverett added backlogged For internal use. Reserved for contributor team workflow. and removed untriaged This issues has not yet been looked at by the Maintainers labels Dec 6, 2023
@neverett
Copy link
Contributor

neverett commented Dec 6, 2023

Added to planned work for docs team.

@eapolinario
Copy link
Contributor

After the Flyte 1.14 release, this is no longer the case.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlogged For internal use. Reserved for contributor team workflow. documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

No branches or pull requests

5 participants