Moved autogen comments out of the doc headers#842
Merged
Conversation
|
|
|
|
yuandrew
approved these changes
Aug 12, 2025
Contributor
yuandrew
left a comment
yuandrew
left a comment
There was a problem hiding this comment.
Thanks for fixing this!
yuandrew
reviewed
Aug 12, 2025
| } | ||
| w.fileMap[fileName].WriteString("---\n\n") | ||
| w.fileMap[fileName].WriteString("{/* NOTE: This is an auto-generated file. Any edit to this file will be overwritten.\n") | ||
| w.fileMap[fileName].WriteString("This file is generated from https://github.com/temporalio/cli/blob/main/temporalcli/commandsgen/commands.yml */}\n") |
Contributor
There was a problem hiding this comment.
nit: Maybe it makes sense to have a double \n after this comment instead of after the --- line
stephanos
pushed a commit
to sivagirish81/cli
that referenced
this pull request
Oct 2, 2025
<!--- Note to EXTERNAL Contributors --> <!-- Thanks for opening a PR! If it is a significant code change, please **make sure there is an open issue** for this. We work best with you when we have accepted the idea first before you code. --> <!--- For ALL Contributors 👇 --> ## What was changed This was breaking the header on the CLI docs pages. Now it's immediately after the header. Here's the commit with the breaking change: temporalio@9fb5fbf Here's the commit showing the breaking change in the docs: temporalio/documentation@c8eec39#diff-0c36e6922979f7bce143e964b8e3b55a32e04f0e686c0bf1982275ce97bc5316 These changes will need to be merged into the docs repo. ## Why? <!-- Tell your future self why have you made these changes --> ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: <!--- Please describe how you tested your changes/how we can test them --> 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
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
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.
What was changed
This was breaking the header on the CLI docs pages. Now it's immediately after the header.
Here's the commit with the breaking change: 9fb5fbf
Here's the commit showing the breaking change in the docs: temporalio/documentation@c8eec39#diff-0c36e6922979f7bce143e964b8e3b55a32e04f0e686c0bf1982275ce97bc5316
These changes will need to be merged into the docs repo.
Why?
Checklist
Closes
How was this tested: