From 5e8bd05ab3a7e33f64168ed813d5809bc4ce115c Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Tue, 2 Apr 2024 10:02:20 -0600 Subject: [PATCH 1/2] Documenting custom materializations --- website/docs/faqs/Docs/documenting-macros.md | 23 ++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/website/docs/faqs/Docs/documenting-macros.md b/website/docs/faqs/Docs/documenting-macros.md index 9a2036cd6bf..1710ced0f1a 100644 --- a/website/docs/faqs/Docs/documenting-macros.md +++ b/website/docs/faqs/Docs/documenting-macros.md @@ -27,3 +27,26 @@ macros: ``` + +## Document a custom materialization + +When you create a [custom materialization](/guides/create-new-materializations), dbt creates an associated macro with the following format: +``` +materialization_{materialization_name}_{adapter} +``` + +To document a custom materialization, use the format above to determine the associated macro name(s) to document. + + + +```yaml +version: 2 + +macros: + - name: materialization_my_materialization_name_default + description: A custom materialization to insert records into an append-only table and track when they were added. + - name: materialization_my_materialization_name_xyz + description: A custom materialization to insert records into an append-only table and track when they were added. +``` + + From b668c7ab235e85ad1f757f898d093046b029da44 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 4 Apr 2024 09:56:56 +0100 Subject: [PATCH 2/2] Update website/docs/faqs/Docs/documenting-macros.md --- website/docs/faqs/Docs/documenting-macros.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/faqs/Docs/documenting-macros.md b/website/docs/faqs/Docs/documenting-macros.md index 1710ced0f1a..2111276baa0 100644 --- a/website/docs/faqs/Docs/documenting-macros.md +++ b/website/docs/faqs/Docs/documenting-macros.md @@ -35,7 +35,7 @@ When you create a [custom materialization](/guides/create-new-materializations), materialization_{materialization_name}_{adapter} ``` -To document a custom materialization, use the format above to determine the associated macro name(s) to document. +To document a custom materialization, use the previously mentioned format to determine the associated macro name(s) to document.