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

[components] Clean up the docs snippets snapshots tests #27996

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

smackesey
Copy link
Collaborator

@smackesey smackesey commented Feb 22, 2025

Summary and Motivation

Clean up the docs snippet CLI snapshot tests:

  • enhance readability by formatting long strings with dedent
  • factor out common context manager

Test Plan

existing test suite

Copy link
Collaborator Author

smackesey commented Feb 22, 2025

7 | key: "target/main/{{ node.name }}
| ^ Unable to parse YAML: while scanning a quoted scalar, found unexpected end of stream
| ^ Unable to parse YAML: while scanning a quoted scalar, found unexpected end of stream
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The caret (^) error indicator appears to be misaligned - it should point to position 44 where the unclosed quote occurs in the line key: "target/main/{{ node.name }}. Proper alignment helps developers quickly identify the exact location of YAML parsing errors.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It points to the right place now and the wrong place before

Copy link

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-1saf6uvcn-elementl.vercel.app
https://sean-components-clean-up-doc-snippets-snapshot-test.archive.dagster-docs.io

Direct link to changed pages:

@smackesey smackesey changed the title [components] Clean up the docs snipppets snapshots tests [components] Clean up the docs snippets snapshots tests Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant