docs: clarify templaters options

quarylabs · Nov 2, 2024 · aefc7a8 · aefc7a8
1 parent 22653be
commit aefc7a8
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/crates/cli/src/docs/generate_templater_docs_template.md b/crates/cli/src/docs/generate_templater_docs_template.md
@@ -10,6 +10,13 @@ FROM users
 WHERE id = :id
 ```
 
+The templater is set in the config file as follows:
+
+```ini
+[sqruff]
+templater = raw
+```
+
 ## Templaters Index
 
 Sqruff comes with the following templaters out of the box:
@@ -21,4 +28,4 @@ Sqruff comes with the following templaters out of the box:
 ### {{ templater.name }}
 
 {{ templater.description }}
-{% endfor %}
+{% endfor %}
diff --git a/crates/lib/src/core/default_config.cfg b/crates/lib/src/core/default_config.cfg
@@ -6,7 +6,7 @@ nocolor = False
 # Supported dialects https://docs.sqlfluff.com/en/stable/dialects.html
 # Or run 'sqlfluff dialects'
 dialect = None
-# One of [raw|jinja|python|placeholder]
+# See templater docs for options
 templater = raw
 # Comma separated list of rules to check, default to core
 rules = core

diff --git a/docs/templaters.md b/docs/templaters.md
@@ -10,6 +10,13 @@ FROM users
 WHERE id = :id
 ```
 
+The templater is set in the config file as follows:
+
+```ini
+[sqruff]
+templater = raw
+```
+
 ## Templaters Index
 
 Sqruff comes with the following templaters out of the box: