-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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] Add guide for code references #21755
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @benpankow and the rest of your teammates on Graphite |
@@ -1159,13 +1159,13 @@ | |||
{ | |||
"title": "Experimental features", | |||
"children": [ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
deprecated, so dropping
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not a huge deal, but ideally would do this in a separate PR where we also drop the mdx and python files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! One thing I'm not sure of is if it should be Code References
or code references
- is this a proprietary feature?
7277f74
to
7ea5960
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll leave it to the other reviewers to stamp for accuracy, but this looks good to me! I left a few small comments, pls address before merging 🙏
assets=with_source_code_references( | ||
[ | ||
my_asset, | ||
another_asset, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
taking away the comma at the end of this line would allow this snippet to condense more
@@ -1159,13 +1159,13 @@ | |||
{ | |||
"title": "Experimental features", | |||
"children": [ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not a huge deal, but ideally would do this in a separate PR where we also drop the mdx and python files
file_path=os.path.join( | ||
os.path.dirname(__file__), "source.yaml" | ||
), | ||
line_number=1, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes me think we should make line_number
optional
48eb1b8
to
62219d7
Compare
62219d7
to
739c3fa
Compare
739c3fa
to
82dd9b7
Compare
b600ef7
to
f3423f1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just clearing my queue -- let me know when this should get a final pass
This is ready for review on content, will need to update the screenshots since the design has changed a little |
f3423f1
to
37567b6
Compare
docs/next/public/images/guides/code-references/manual_references.png
Outdated
Show resolved
Hide resolved
d833a1c
to
b8f570e
Compare
b8f570e
to
9ff3f56
Compare
Merge activity
|
9ff3f56
to
c8a8df7
Compare
Summary
Add guide for basic local code references functionality. Will stack PR for source control references, when ready.
Test Plan
viewed locally
https://benpankow-guide-code-references.dagster.dagster-docs.io/guides/dagster/code-references