[docs] updates docs to favor @dataclass for component authoring #28900
Conversation
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
...es/docs_snippets/docs_snippets/guides/components/shell-script-component/with-custom-scope.py
Outdated
Show resolved
Hide resolved
| from dagster import Definitions | ||
| from dagster_components import ( | ||
| Component, | ||
| ComponentLoadContext, | ||
| Resolvable, | ||
| ) | ||
|
|
||
| @dataclass(frozen=True) |
There was a problem hiding this comment.
This also updates the template used in scaffolding, please let me know if this is okay.
There was a problem hiding this comment.
so the scaffolding is worthy of discussion. we specifically wanted to be agnostic to this, as not everyone uses dataclasses
There was a problem hiding this comment.
Ah understood, for now I will revert that change in this PR.
How do you feel about being opinionated about using data classes in the tutorial? Should we have a tab selection and present both options, or is showing the dataclass sufficient?
...ocs_snippets/docs_snippets/guides/components/shell-script-component/2-shell-command-empty.py
Outdated
Show resolved
Hide resolved
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-njwkrbt51-elementl.vercel.app Direct link to changed pages: |
|
should we add a little bit of docs explanation for the dataclass usage? like make it clear that dataclass usage is optional but gets rid of boilerplate |
|
So I think we should scaffold |
| @@ -9,17 +9,12 @@ | |||
| import dagster as dg | |||
|
|
|||
|
|
|||
| @dataclass | |||
| @dataclass(frozen=True) | |||
There was a problem hiding this comment.
although we use frozen internally our scaffolding does not product it so it might just be confusing.
Summary & Motivation
Current docs promote
__init__methods for defining YAML schema. This updates the tutorial to use data classes.How I Tested These Changes
Changelog
NOCHANGELOG