Skip to content
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

Jump to bottom

Add Comment in Generated Code Indicating Source and Generated Status as Best Practice in Jinja Templates #440

Open
lquerel opened this issue Nov 1, 2024 · 0 comments
Open

Add Comment in Generated Code Indicating Source and Generated Status as Best Practice in Jinja Templates #440

lquerel opened this issue Nov 1, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lquerel
Copy link
Contributor

lquerel commented Nov 1, 2024

As @marcalff mentioned in the following comment #227 (comment) it would be a good practice to systematically add a comment in generated code to indicate:

  1. That it is generated code.
  2. Where it was generated from.

This practice should be strongly recommended as a best practice in the Jinja templates.
@lquerel lquerel added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 1, 2024
@lquerel lquerel mentioned this issue Nov 1, 2024
Open
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
OTel Weaver Project
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lquerel