Skip to content

Commit 2f3fa07

Browse files
committed
docs: Fix default values in documentation
1 parent db76233 commit 2f3fa07

File tree

2 files changed

+7
-11
lines changed

2 files changed

+7
-11
lines changed

cosmos/config.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,7 @@ class ProjectConfig:
165165
:param copy_dbt_packages: Copy dbt_packages directory, if it exists, instead of creating a symbolic link. If not set, fetches the value from [cosmos]default_copy_dbt_packages (False by default).
166166
:param models_relative_path: The relative path to the dbt models directory within the project. Defaults to models
167167
:param seeds_relative_path: The relative path to the dbt seeds directory within the project. Defaults to seeds
168-
:param snapshots_relative_path: The relative path to the dbt snapshots directory within the project. Defaults to
169-
snapshots
168+
:param snapshots_relative_path: The relative path to the dbt snapshots directory within the project. Defaults to snapshots
170169
:param manifest_path: The absolute path to the dbt manifest file. Defaults to None
171170
:param manifest_conn_id: Name of the Airflow connection used to access the manifest file if it is not stored locally. Defaults to None
172171
:param project_name: Allows the user to define the project name.

docs/configuration/project-config.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@ The ``cosmos.config.ProjectConfig`` allows you to specify information about wher
55
variables that should be used for rendering and execution. It takes the following arguments:
66

77
- ``dbt_project_path``: The full path to your dbt project. This directory should have a ``dbt_project.yml`` file
8-
- ``models_relative_path``: The path to your models directory, relative to the ``dbt_project_path``. This defaults to
9-
``models/``
10-
- ``seeds_relative_path``: The path to your seeds directory, relative to the ``dbt_project_path``. This defaults to
11-
``data/``
12-
- ``snapshots_relative_path``: The path to your snapshots directory, relative to the ``dbt_project_path``. This defaults
13-
to ``snapshots/``
8+
- ``models_relative_path``: The path to your models directory, relative to the ``dbt_project_path``. This defaults to ``models``
9+
- ``seeds_relative_path``: The path to your seeds directory, relative to the ``dbt_project_path``. This defaults to ``seeds``
10+
- ``snapshots_relative_path``: The path to your snapshots directory, relative to the ``dbt_project_path``. This defaults to ``snapshots``
1411
- ``manifest_path``: The absolute path to your manifests directory. This is only required if you're using Cosmos' manifest
1512
parsing mode. Along with supporting local paths for manifest parsing, starting with Cosmos 1.6.0, if you've
1613
Airflow >= 2.8.0, Cosmos also supports remote paths for manifest parsing(e.g. S3 URL). See :ref:`parsing-methods` for more details.
@@ -39,9 +36,9 @@ Project Config Example
3936
4037
config = ProjectConfig(
4138
dbt_project_path="/path/to/dbt/project",
42-
models_relative_path="models",
43-
seeds_relative_path="data",
44-
snapshots_relative_path="snapshots",
39+
models_relative_path="custom_models_folder",
40+
seeds_relative_path="custom_seeds_folder",
41+
snapshots_relative_path="custom_snapshots_folder",
4542
manifest_path="/path/to/manifests",
4643
env_vars={"MY_ENV_VAR": "my_env_value"},
4744
dbt_vars={

0 commit comments

Comments
 (0)