[dg] Pull in pydantic.Field(examples=...) into components autodocs #27956
Conversation
This file contains 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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
benpankow
force-pushed
the
benpankow/components-docs-examples
branch
from
fd238a7 to
9609880
Compare
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.
Summary
pydantic.Fieldhas a native way to specify field examples. We can use this to populate example values in components autodocs, rather than the default, not too useful example values of'...',0etc.See https://github.com/dagster-io/dagster/pull/27956/files#diff-737e9f606f52a5e1a9b5bd54cbd5f5591c7276e3bd236def504db612930919a9 for a sample.
How I Tested These Changes
Update unit test.