Skip to content

[dagster-pipes, docs] apply ruff to docs_snippets #24935

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

danielgafni
Copy link
Contributor

@danielgafni danielgafni commented Oct 1, 2024

Summary & Motivation

This PR applies ruff to docs_snippets for Dagster Pipes docs.
This is done by adding a examples/docs_snippets/docs_snippets/guides/dagster/dagster_pipes/ruff.toml file extending the main ruff config.

How I Tested These Changes

Changelog

NOCHANGELOG

Copy link

github-actions bot commented Oct 1, 2024

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-q5hx9gtpl-elementl.vercel.app
https://10-01--dagster-pipes-docs-apply-ruff-to-docs-snippets.dagster.dagster-docs.io

Direct link to changed pages:

@danielgafni danielgafni force-pushed the 09-03-_dagster-aws_docs_add_docs_for_pipesemrserverlessclient branch from 6e48e07 to bddf8f1 Compare October 1, 2024 11:28
@danielgafni danielgafni force-pushed the 10-01-_dagster-pipes_docs_apply_ruff_to_docs_snippets branch from 6e81958 to 5ea968a Compare October 1, 2024 11:28
Base automatically changed from 09-03-_dagster-aws_docs_add_docs_for_pipesemrserverlessclient to master October 1, 2024 11:41
@danielgafni danielgafni marked this pull request as ready for review October 1, 2024 13:32
@graphite-app graphite-app bot added the area: docs Related to documentation in general label Oct 1, 2024
@graphite-app graphite-app bot requested a review from C00ldudeNoonan October 1, 2024 13:33
@danielgafni
Copy link
Contributor Author

Mostly the changes are harmless, but I've spotted a few docs with multiple pieces of the same code snippet where imports reordering affected the first import appearance.

I'm not looking for a full review before before I fix these small issues. @cmpadden @PedramNavid what are your thoughts on this idea in general?

@cmpadden
Copy link
Contributor

cmpadden commented Oct 1, 2024

Mostly the changes are harmless, but I've spotted a few docs with multiple pieces of the same code snippet where imports reordering affected the first import appearance.

I'm not looking for a full review before before I fix these small issues. @cmpadden @PedramNavid what are your thoughts on this idea in general?

@danielgafni I am generally in favor of enforcing the same style throughout the code base. So applying our main ruff configuration to the pipes examples seems like a good idea to me.

To be honest, I'm surprised this wasn't already happening.

@danielgafni
Copy link
Contributor Author

danielgafni commented Oct 1, 2024

Yeah I decided to start with Pipes because it's my area of responsibility, but we probably want to extend this practice to all examples and docs at some point.

@@ -0,0 +1,163 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

If possible, could you separate the new guide content from the ruff formatting of docs_snippets?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants