Skip to content

Commit

Permalink
Clarify usage of Templated variables
Browse files Browse the repository at this point in the history
This fixes #603
  • Loading branch information
LandonTClipp committed Apr 20, 2023
1 parent a1cd1d3 commit d69189e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d69189e

Please sign in to comment.