[components] api doc refresh #30231
Merged
[components] api doc refresh #30231
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alangenfeld
force-pushed
the
al/05-23-_components_api_doc_refresh
branch
2 times, most recently
from
026d33e to
5384e8a
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
neverett
approved these changes
May 28, 2025
Contributor
neverett
left a comment
neverett
left a comment
There was a problem hiding this comment.
Left a few suggestions, including one to fix the broken API docs link, otherwise LGTM!
| - The assets the shell script is expected to produce | ||
|
|
||
| The `ShellCommand` class inherits from <PyObject section="resolved" module="dagster.components" object="Resolvable" />, in addition to <PyObject section="components" module="dagster.components" object="Component" />. `Resolvable` handles deriving a YAML schema for the `ShellCommand` class based on what the class is annotated with. To simplify common use cases, Dagster provides annotations for common bits of configuration, such as `ResolvedAssetSpec`, which will handle exposing a schema for defining <PyObject section="assets" module="dagster" object="AssetSpec" pluralize /> from YAML and resolving them before instantiating the component. | ||
| The `ShellCommand` class inherits from <PyObject section="resolved" module="dagster" object="Resolvable" />, in addition to <PyObject section="components" module="dagster" object="Component" />. `Resolvable` handles deriving a YAML schema for the `ShellCommand` class based on what the class is annotated with. To simplify common use cases, Dagster provides annotations for common bits of configuration, such as `ResolvedAssetSpec`, which will handle exposing a schema for defining <PyObject section="assets" module="dagster" object="AssetSpec" pluralize /> from YAML and resolving them before instantiating the component. |
Contributor
There was a problem hiding this comment.
Suggested change
| The `ShellCommand` class inherits from <PyObject section="resolved" module="dagster" object="Resolvable" />, in addition to <PyObject section="components" module="dagster" object="Component" />. `Resolvable` handles deriving a YAML schema for the `ShellCommand` class based on what the class is annotated with. To simplify common use cases, Dagster provides annotations for common bits of configuration, such as `ResolvedAssetSpec`, which will handle exposing a schema for defining <PyObject section="assets" module="dagster" object="AssetSpec" pluralize /> from YAML and resolving them before instantiating the component. | |
| The `ShellCommand` class inherits from <PyObject section="components" module="dagster" object="Resolvable" />, in addition to <PyObject section="components" module="dagster" object="Component" />. `Resolvable` handles deriving a YAML schema for the `ShellCommand` class based on what the class is annotated with. To simplify common use cases, Dagster provides annotations for common bits of configuration, such as `ResolvedAssetSpec`, which will handle exposing a schema for defining <PyObject section="assets" module="dagster" object="AssetSpec" pluralize /> from YAML and resolving them before instantiating the component. |
| ----------- | ||
|
|
||
| These Annotated TypeAliases can be used when defining custom Components for | ||
| common dagster types. |
Contributor
There was a problem hiding this comment.
Suggested change
| common dagster types. | |
| common Dagster types. |
| .. py:data:: ResolvedAssetKey | ||
| :type: Annotated[AssetKey, ...] | ||
|
|
||
| Allows resolving to an AssetKey via a yaml friendly schema. |
Contributor
There was a problem hiding this comment.
Suggested change
| Allows resolving to an AssetKey via a yaml friendly schema. | |
| Allows resolving to an AssetKey via a YAML-friendly schema. |
| .. py:data:: ResolvedAssetSpec | ||
| :type: Annotated[AssetSpec, ...] | ||
|
|
||
| Allows resolving to an AssetSpec via a yaml friendly schema. |
Contributor
There was a problem hiding this comment.
Suggested change
| Allows resolving to an AssetSpec via a yaml friendly schema. | |
| Allows resolving to an AssetSpec via a YAML-friendly schema. |
| .. py:data:: ResolvedAssetCheckSpec | ||
| :type: Annotated[AssetCheckSpec, ...] | ||
|
|
||
| Allows resolving to an AssetCheckSpec via a yaml friendly schema. |
Contributor
There was a problem hiding this comment.
Suggested change
| Allows resolving to an AssetCheckSpec via a yaml friendly schema. | |
| Allows resolving to an AssetCheckSpec via a YAML-friendly schema. |
alangenfeld
force-pushed
the
al/05-23-_components_api_doc_refresh
branch
from
fafa0f6 to
ba77328
Compare
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-dglsmu7z5-elementl.vercel.app Direct link to changed pages: |
Member
Author
Merge activity
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
How I Tested These Changes
rebuild api docs and run docs locally, look at api docs entry for components