Skip to content

Commit

Permalink
Update contract.md (#5171)
Browse files Browse the repository at this point in the history
Hi.
This proposal of modification is intended to keep the common praxis in
all the examples present in your docs, that is, always attach a
reference to the name of the file where the reader might find this
particular instance of configuration. As a matter of fact, I copied and
edited such reference from the example below the one I'm editing.
Regards.
IL

## What are you changing in this pull request and why?
<!---
Describe your changes and why you're making them. If related to an open 
issue or a pull request on dbt Core, then link to them here! 

To learn more about the writing conventions used in the dbt Labs docs,
see the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md).
-->

## Checklist
<!--
Uncomment when publishing docs for a prerelease version of dbt:
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [ ] Add a checklist item for anything that needs to happen before this
PR is merged, such as "needs technical review" or "change base branch."

Adding or removing pages (delete if not applicable):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
  • Loading branch information
mirnawong1 authored Mar 27, 2024
2 parents 3110bea + 1c9f53f commit 02e13c7
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion website/docs/reference/resource-configs/contract.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ dbt uses built-in type aliasing for the `data_type` defined in your YAML. For ex

Example for disabling:

<File name='FOLDER_NAME/FILE_NAME.yml'>

```yml

models:
Expand All @@ -37,6 +39,7 @@ models:

```

</File>
</VersionBlock>

When dbt compares data types, it will not compare granular details such as size, precision, or scale. We don't think you should sweat the difference between `varchar(256)` and `varchar(257)`, because it doesn't really affect the experience of downstream queriers. You can accomplish a more-precise assertion by [writing or using a custom test](/best-practices/writing-custom-generic-tests).
Expand Down Expand Up @@ -115,4 +118,4 @@ Why `append_new_columns`, rather than `sync_all_columns`? Because removing exist
## Related documentation
- [What is a model contract?](/docs/collaborate/govern/model-contracts)
- [Defining `columns`](/reference/resource-properties/columns)
- [Defining `constraints`](/reference/resource-properties/constraints)
- [Defining `constraints`](/reference/resource-properties/constraints)

0 comments on commit 02e13c7

Please sign in to comment.