Skip to content

Document generated file header best practice #1085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cnaples79 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document generated file header best practice #1085

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/codegen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down