Include generated comment in docs #740
Merged
+17
−6
Conversation
This file contains 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
This helps developers avoid accidentally sending PRs against generated content. Based on upstream template https://github.com/bazelbuild/stardoc/blob/master/stardoc/templates/markdown_tables/header.vm
|
Is there anything that checks for this comment or is this just a guide for contributors? |
|
On my docsite I use this to avoid duplicating content that I also generate |
UebelAndre
approved these changes
May 17, 2021
|
Thanks, I updated https://docs.aspect.dev/rules_rust with the latest |
|
@alexeagle just FYI, I'm getting a 404 on the links there. Not sure if that's just on my end though 😅 |
|
Yeah thanks, I need to server-side redirect .md extension to .html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 helps developers avoid accidentally sending PRs against generated content.
Based on upstream template https://github.com/bazelbuild/stardoc/blob/master/stardoc/templates/markdown_tables/header.vm