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.

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

Feature request: generate header comment on generated files #811

Open
kubukoz opened this issue Oct 30, 2023 · 0 comments
Open

Feature request: generate header comment on generated files #811

kubukoz opened this issue Oct 30, 2023 · 0 comments

Comments

@kubukoz
Copy link

kubukoz commented Oct 30, 2023

Sometimes it's not easy to notice at first sight that a file has been generated from another, especially if --check isn't in place.

It would be great to have some sort of signifier in the generated files, making it more obvious that they're not the source.

For example, something like:

<!-- ATTENTION: This is generated code. -->
<!-- This file has been generated by mdoc from the input file input/file.md. -->
<!-- Do NOT edit it manually, as it may get out of sync with the sources! Edit the input file instead. -->

at the beginning of each generated file, configurable via the usual config mechanism.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant