Add -generated-notice, as suggested by #99Add -generated-file-notice, as suggested by #99 #132
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As suggested by #99, this PR adds a new flag allowing to add a "Generated file" notice in the raw README, via a HTML comment.
This makes the comment invisible in rendered Markdown, but visible when editing the raw file.
CLI flag is
-generated-notice
and JSON field isgenerated_notice
.Default value is
false
(compatible with current behavior).I feel like this one could be true by default. If true by default, I'm not sure how to implement it with the JSON config, or if I should change it to something like
skip-generated-notice
?Any opinion/idea is welcome.
Test has been added too.
Closes #99