From d69189e0ce5ad10396d0a1967eb8aba9107a8972 Mon Sep 17 00:00:00 2001 From: LandonTClipp Date: Thu, 20 Apr 2023 14:42:52 -0500 Subject: [PATCH] Clarify usage of Templated variables This fixes #603 --- docs/configuration.md | 5 +++++ docs/features.md | 3 +++ 2 files changed, 8 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 6529c07a..649a6e90 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -36,6 +36,8 @@ Parameter Descriptions ### non-`packages` + These are the configuration options available when using the legacy, non-`packages` configuration semantics. + #### Config Variables These are the configuration options when not using the [`packages`](/mockery/features/#packages-configuration) config @@ -88,6 +90,9 @@ Parameter Descriptions #### Template variables + !!! note + Templated variables are only available when using the `packages` config feature. + Variables that are marked as being templated are capable of using mockery-provided template parameters. | name | description | diff --git a/docs/features.md b/docs/features.md index c5a3c25b..5ff4de03 100644 --- a/docs/features.md +++ b/docs/features.md @@ -141,6 +141,9 @@ packages: ### Templated variables +!!! note + Templated variables are only available when using the `packages` config feature. + Included with this feature is the ability to use templated strings for various configuration options. This is useful to define where your mocks are placed and how to name them. You can view the template variables available in the [Configuration](/mockery/configuration/#parameter-descriptions) section of the docs, under the `packages config` tab. ### Layouts