Docs: Add a warning about "!include" usage with YAML files

copier-org · Aug 3, 2020 · 173db40 · 173db40
1 parent b94b7f4
commit 173db40
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/creating.md b/docs/creating.md
@@ -289,6 +289,16 @@ common_setting: "1"
 !include other_place/include_me.yml
 ```
 
+**Warning**: You can't have in the same file a top `!include` tag and classic YAML
+syntax, see
+[this pyyaml-include issue](https://github.com/tanbro/pyyaml-include/issues/7).
+
+```yaml
+# Invalid file
+!include other_place/include_me.yml
+foo: "bar"
+```
+
 ## The `.copier-answers.yml` file
 
 If the destination path exists and a `.copier-answers.yml` file is present there, it