diff --git a/website/docs/faqs/Docs/documenting-macros.md b/website/docs/faqs/Docs/documenting-macros.md index 9a2036cd6bf..2111276baa0 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 previously mentioned format 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. +``` + +