chore(docs): add more 'autogenerated' comments #3655
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isaacs
force-pushed
the
isaacs/auto-generated-docs-comment
branch
from
af29f62 to
dd2de43
Compare
nlf
approved these changes
Aug 17, 2021
Contributor
nlf
left a comment
nlf
left a comment
There was a problem hiding this comment.
good call on the extra comments, and the test in CI! i like it
When we accidentally edit the auto-generated portions of the docs, this will catch the error and cause CI to fail. Later phase automated safety check that the early-stage human commenting in the last commit also addresses. Re: #3654 Re: #3630 PR-URL: #3655 Credit: @isaacs Close: #3655 Reviewed-by: @nlf
wraithgar
force-pushed
the
isaacs/auto-generated-docs-comment
branch
from
7d50d67 to
7a58264
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This should prevent the kind of thing we've seen where people edit the
generated docs, as in #3654 and #3630, and provide them with a helpful
pointer so they put the config documentation changes in the right place.
References