[Core] Allow instances of generic data tests to be documented dbt-core #2578 #6293
Assignees
Labels
content
Improvements or additions to content
dbt Core
The changes proposed in this issue relate to dbt Core
dbt-core v1.9
improvement
Use this when an area of the docs needs improvement as it's currently unclear
Comments
runleonarun
added
content
runleonarun
changed the title
runleonarun
changed the title
matthewshaver
added a commit
that referenced
this issue
Oct 24, 2024
## What are you changing in this pull request and why? Generic Test descriptions can now be documented Closes #6293 ## Checklist - [ ] I have reviewed 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. - [ ] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [ ] I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." <!-- PRE-RELEASE VERSION OF dbt (if so, uncomment): - [ ] 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) --> <!-- ADDING OR REMOVING PAGES (if so, uncomment): - [ ] 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 --> <!-- vercel-deployment-preview --> --- 🚀 Deployment available! Here are the direct links to the updated files: - https://docs-getdbt-com-git-test-description-dbt-labs.vercel.app/reference/resource-properties/description <!-- end-vercel-deployment-preview --> --------- Co-authored-by: Mirna Wong <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
At a minimum, update body to include a link to the page on docs.getdbt.com requiring updates and what part(s) of the page you would like to see updated.
Originating from this issue: dbt-labs/dbt-core#2578
Key changes include the addition of a
descriptionattribute to generic tests, updates to the parser to handle this new attribute, and new functional and unit tests to verify the implementation.Enhancements to Generic Data Tests:
descriptionattribute to generic tests incore/dbt/parser/generic_test_builders.pyto allow users to provide descriptions for tests, and ensured it is not passed into the test macro or name synthesis.create_test_nodeandparse_generic_testfunctions incore/dbt/parser/schema_generic_tests.pyto include thedescriptionattribute in the test node metadata.The text was updated successfully, but these errors were encountered: