Merge pull request #1338 from hairyhenderson/clarify-inputdir-recursi…

…veness Clarify that inputDir is read recursively
hairyhenderson · Mar 11, 2022 · bc706d8 · bc706d8
2 parents cf1f215 + 69cd0fa
commit bc706d8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/content/config.md b/docs/content/config.md
@@ -190,8 +190,9 @@ May not be used with `inputDir` or `inputFiles`.
 
 See [`--input-dir`](../usage/#input-dir-and-output-dir).
 
-The directory containing input template files. Must be used with 
-[`outputDir`](#outputdir) or [`outputMap`](#outputmap). Can also be used with [`excludes`](#excludes).
+The directory containing input template files. All files contained within will
+be processed recursively. Must be used with [`outputDir`](#outputdir) or
+[`outputMap`](#outputmap). Can also be used with [`excludes`](#excludes).
 
 ```yaml
 inputDir: templates/

diff --git a/docs/content/usage.md b/docs/content/usage.md
@@ -50,7 +50,7 @@ You can specify multiple `--file` and `--out` arguments. The same number of each
 
 ### `--input-dir` and `--output-dir`
 
-For processing multiple templates in a directory you can use `--input-dir` and `--output-dir` together. In this case all files in input directory will be processed as templates and the resulting files stored in `--output-dir`. The output directory will be created if it does not exist and the directory structure of the input directory will be preserved.
+For processing multiple templates in a directory you can use `--input-dir` and `--output-dir` together. In this case all files in input directory will be processed recursively as templates and the resulting files stored in `--output-dir`. The output directory will be created if it does not exist and the directory structure of the input directory will be preserved.
 
 You can use the [`--exclude`](#exclude) argument and/or a [`.gomplateignore`](#ignorefile) file to exclude some of the files in the input directory.