search

SAP / abap-file-formats

File formats that define and specify the file representation for ABAP development objects
MIT License
58 stars 56 forks source link

Add comment in auto generated files #110

Closed larshp closed 3 years ago

larshp commented 3 years ago

add comment in auto generated files that they are auto generated, ie. should not be edited manually

schneidermic0 commented 3 years ago

This could be done by adding a $comment at the beginning of the document.

https://json-schema.org/understanding-json-schema/reference/generic.html#comments

larshp commented 3 years ago

it's only possible for SAP to implement this issue, as the code for JSON generation is proprietary

schneidermic0 commented 3 years ago

I have talked to the team, today. It agrees to add a $comment.

larshp commented 3 years ago

Suggestion: "$comment": "This file is autogenerated, do not edit manually, see https://github.com/SAP/abap-file-formats for more information"