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

[du] consistency issues #26416

Merged
merged 2 commits into from
Dec 13, 2024
Merged

[du] consistency issues #26416

merged 2 commits into from
Dec 13, 2024

Conversation

dehume
Copy link
Contributor

@dehume dehume commented Dec 11, 2024

Summary & Motivation

Minor consistency issues from working through Dagster University

How I Tested These Changes

Changelog

Insert changelog entry or delete this section.

Copy link

github-actions bot commented Dec 11, 2024

Deploy preview for dagster-university ready!

✅ Preview
https://dagster-university-ie8bkbyfw-elementl.vercel.app
https://du-consistency-issues.dagster-university.dagster-docs.io

Built with commit 2a0e509.
This pull request is being automatically deployed with vercel-action

@@ -9,11 +9,12 @@ lesson: '2'
To install Dagster, you’ll need:

- **To install Python**. Dagster supports Python 3.9 through 3.12.
- **A package manager like pip or poetry**. If you need to install a package manager, refer to the following installation guides:
- **A package manager like pip, poetry or uv**. If you need to install a package manager, refer to the following installation guides:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding in uv as an option since we use that other places in the repo and was what I used to complete the class

Copy link
Contributor

Choose a reason for hiding this comment

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

I would capitalize "poetry" here for consistency and add a comma after it.

@@ -10,8 +10,8 @@ An asset is an object in persistent storage that captures some understanding of

- **A database table or view**, such as those in a Google BigQuery data warehouse
- **A file**, such as a file in your local machine or blob storage like Amazon S3
- **A machine learning model**
- **An asset from an integration,** like a dbt model or a Fivetran connector
- **A machine learning model**, such as TensorFlow or PyTorch
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding in example since it was the only bullet point without one

@@ -30,7 +30,7 @@ The asset you built should look similar to the following code. Click **View answ
deps=["taxi_zones_file"]
)
def taxi_zones() -> None:
sql_query = f"""
query = f"""
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Standardizing around query as the variable name since that is what the dagster university repo uses in functions

> import duckdb
> conn = duckdb.connect(database="data/staging/data.duckdb") # assumes you're writing to the same destination as specified in .env.example
> conn.execute("select count(*) from trips").fetchall()
import duckdb
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing > for consistency and so it is easier to copy and run in Python REPL

@@ -63,7 +63,7 @@ To add the partition to the asset:
@asset(
partitions_def=monthly_partition
)
def taxi_trips_file(context) -> None:
def taxi_trips_file(context: AssetExecutionContext) -> None:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

First example snippet uses type annotation. Including for consistency

@dehume dehume marked this pull request as ready for review December 11, 2024 21:18
@dehume dehume requested a review from neverett as a code owner December 11, 2024 21:18
Copy link

github-actions bot commented Dec 11, 2024

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-8fuc6jrnl-elementl.vercel.app
https://du-consistency-issues.dagster.dagster-docs.io

Direct link to changed pages:

Copy link
Contributor

@cmpadden cmpadden left a comment

Choose a reason for hiding this comment

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

Nice, good attention to detail!

Out of curiosity, did you notice any discrepancies in screenshots when you completed the course? Maintaining screenshots has been quite a pain to maintain since you essentially need to be at the specific step in the course to capture it.

@dehume
Copy link
Contributor Author

dehume commented Dec 12, 2024

Out of curiosity, did you notice any discrepancies in screenshots when you completed the course? Maintaining screenshots has been quite a pain to maintain since you essentially need to be at the specific step in the course to capture it.

Yeah. A lot of the screenshots need updating (specifically the tabs around automation). I wrote up a ticket for myself to update those when we update content to the latest version

Copy link
Contributor

@neverett neverett left a comment

Choose a reason for hiding this comment

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

One tiny comment, otherwise this looks good to me!

@@ -9,11 +9,12 @@ lesson: '2'
To install Dagster, you’ll need:

- **To install Python**. Dagster supports Python 3.9 through 3.12.
- **A package manager like pip or poetry**. If you need to install a package manager, refer to the following installation guides:
- **A package manager like pip, poetry or uv**. If you need to install a package manager, refer to the following installation guides:
Copy link
Contributor

Choose a reason for hiding this comment

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

I would capitalize "poetry" here for consistency and add a comma after it.

@dehume dehume merged commit a4fdec7 into master Dec 13, 2024
2 of 3 checks passed
@dehume dehume deleted the du-consistency-issues branch December 13, 2024 13:44
pskinnerthyme pushed a commit to pskinnerthyme/dagster that referenced this pull request Dec 16, 2024
## Summary & Motivation
Minor consistency issues from working through Dagster University

## How I Tested These Changes

## Changelog

> Insert changelog entry or delete this section.
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.

3 participants