Repository navigation
[docs-sync] Update documentation for recent code changes - #13
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Document the reserved-word operation renaming behavior introduced in commit dae0917: operations like 'delete' inside operation groups are now automatically renamed by appending the singularized group name (e.g., deleteConversation). Document the @clientName escape hatch, top-level operation fallback, and the intentional ARM exception. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This branch has not been deployed
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
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.
Summary
This PR adds documentation for a behavioral change in the
@azure-tools/typespec-tsemitter introduced in commit dae0917.What changed in code
Commit:
[typespec-ts] Rename reserved-word operations using singularized group name(Azure#5154)Reserved-word operations (e.g.
delete,in,new) that belong to an operation group are now renamed by appending the singularized operation group name instead of emitting a$-guarded name with a@fixmedoc comment.For example, a
deleteoperation in aConversationsinterface now generatesdeleteConversationinstead of$delete.Documentation added
website/src/content/docs/docs/emitters/clients/typespec-ts/operation-naming.md@clientNameescape hatch for opting out of the rename