Skip to content

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

New issue
New issue
Open
Feature
#1085
Open
Add Comment in Generated Code Indicating Source and Generated Status as Best Practice in Jinja Templates#440
Feature
#1085
Labels
documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is neededtemplate engineThis represents an issue around our template engine, e.g. jinja filters, tests, functions.
@lquerel

Description

@lquerel
lquerel
opened on 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is neededtemplate engineThis represents an issue around our template engine, e.g. jinja filters, tests, functions.

    Type

    Feature

    Projects

    OTel Weaver Project

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions