Skip to content

Commit

Permalink
rename, clean up
Browse files Browse the repository at this point in the history
Signed-off-by: nikki everett <[email protected]>
  • Loading branch information
neverett committed Feb 22, 2025
1 parent 2b5bc72 commit 780e6ad
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ project root directory (`jaffle_platform`).

:::note

For more information about the configuration sections and settings in pyproject.toml, see "[pyproject.toml configuration](pyproject-toml)".
For more information about the sections and settings in pyproject.toml, see "[pyproject.toml settings](pyproject-toml)".

:::

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Files and directories in a components project'
title: 'pyproject.toml settings'
sidebar_position: 500
---

Expand All @@ -9,20 +9,19 @@ This article assumes you have already [created a project with components](creati

:::

`pyproject.toml` contains a `tool.dagster` and `tool.dg` section that look like
this:
`pyproject.toml` contains `tool.dagster` and `tool.dg` sections:

<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/index/4-pyproject.toml" language="TOML" title="jaffle-platform/pyproject.toml" />

### tool.dagster section
### `tool.dagster` section

The `tool.dagster` section of `pyproject.toml` is not `dg`-specific. This section specifies that a set of definitions can be loaded from the `jaffle_platform.definitions` module.

### tool.dg section
### `tool.dg` section

The `tool.dg` section contains two settings requiring more explanation: `is_project` and `is_component_lib`.
The `tool.dg` section contains `is_project` and `is_component_lib` settings.

#### is_project setting
#### `is_project` setting

`is_project = true` specifies that this project is a `dg`-managed Dagster project. Projects created with components are regular Dagster projects with a particular structure.

Expand All @@ -38,7 +37,7 @@ This call to `build_component_defs` will:

`is_project` is telling `dg` that the project is structured in this way and therefore contains component instances. In the current project, component instances will be placed in the default location at `jaffle_platform/components`.

#### is_component_lib setting
#### `is_component_lib` setting

`is_component_lib = true` specifies that the project is a component library. This means that the project may contain component types that can be referenced when generating component instances.

Expand Down

0 comments on commit 780e6ad

Please sign in to comment.