diff --git a/docs/codegen.md b/docs/codegen.md index 985b3a66e..c4c1b35b3 100644 --- a/docs/codegen.md +++ b/docs/codegen.md @@ -111,6 +111,10 @@ This output in turn is passed to the `metrics.md.j2` template, evaluated by the ## Tips and Tricks +#### Mark generated files + +Add a short header comment in each template output noting that the file is generated and which template produced it. This helps downstream users avoid hand-editing generated artifacts and makes it easier to trace changes back to the source template. + #### Use `debug()` Jinja2 can be overwhelming and hard to discover. Try putting `debug()` somewhere in your code: