Skip to content

Commit

Permalink
Small whitespace and verbiage changes
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeatty10 committed Nov 10, 2023
1 parent e0e8309 commit 26d7cf1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 10 deletions.
5 changes: 4 additions & 1 deletion website/docs/reference/configs-and-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A rule of thumb: properties declare things _about_ your project resources; confi

For example, you can use resource **properties** to:
* Describe models, snapshots, seed files, and their columns
- Assert "truths" about a model, in the form of [tests](/docs/build/tests), e.g. "this `id` column is unique"
* Assert "truths" about a model, in the form of [tests](/docs/build/tests), e.g. "this `id` column is unique"
* Define pointers to existing tables that contain raw data, in the form of [sources](/docs/build/sources), and assert the expected "freshness" of this raw data
* Define official downstream uses of your data models, in the form of [exposures](/docs/build/exposures)

Expand Down Expand Up @@ -67,12 +67,14 @@ Previous versions of the docs referred to these as `schema.yml` files — we've
dbt has the ability to define node configs in `.yml` files, in addition to `config()` blocks and `dbt_project.yml`. But the reverse isn't always true: there are some things in `.yml` files that can _only_ be defined there.

Certain properties are special, because:

- They have a unique Jinja rendering context
- They create new project resources
- They don't make sense as hierarchical configuration
- They're older properties that haven't yet been redefined as configs

These properties are:

- [`description`](/reference/resource-properties/description)
- [`tests`](/reference/resource-properties/tests)
- [`docs`](/reference/resource-configs/docs)
Expand Down Expand Up @@ -202,3 +204,4 @@ Runtime Error
```

This error occurred because a semicolon (`;`) was accidentally used instead of a colon (`:`) after the `description` field. To resolve issues like this, find the `.yml` file referenced in the error message and fix any syntax errors present in the file. There are online YAML validators that can be helpful here, but please be mindful of submitting sensitive information to third-party applications!

3 changes: 2 additions & 1 deletion website/docs/reference/dbt_project.yml.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Every [dbt project](/docs/build/projects) needs a `dbt_project.yml` file — this is how dbt knows a directory is a dbt project. It also contains important information that tells dbt how to operate on your project.
Every [dbt project](/docs/build/projects) needs a `dbt_project.yml` file — this is how dbt knows a directory is a dbt project. It also contains important information that tells dbt how to operate your project.

<VersionBlock lastVersion="1.4">

Expand Down Expand Up @@ -96,6 +96,7 @@ vars:
<VersionBlock lastVersion="1.5">
<File name='dbt_project.yml'>
```yml
Expand Down
10 changes: 2 additions & 8 deletions website/docs/reference/resource-configs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ default_value: {show: true}
{ label: 'Macros', value: 'macros', },
]
}>

<TabItem value="models">

<File name='models/schema.yml'>


```yml
version: 2

Expand All @@ -29,7 +31,6 @@ models:
docs:
show: true | false
node_color: "black"

```
</File>
Expand All @@ -53,9 +54,7 @@ seeds:
- name: seed_name
docs:
show: true | false

```

</File>
</TabItem>
Expand All @@ -71,9 +70,7 @@ snapshots:
- name: snapshot_name
docs:
show: true | false

```

</File>
</TabItem>
Expand All @@ -90,7 +87,6 @@ analyses:
docs:
show: true | false
```
</File>
</TabItem>
Expand All @@ -110,9 +106,7 @@ macros:
- name: macro_name
docs:
show: true | false

```

</File>
Also refer to [macro properties](/reference/macro-properties).
</TabItem>
Expand Down

0 comments on commit 26d7cf1

Please sign in to comment.