Open
Fix ARM library doc-comment typos and regenerate reference docs#5070
Conversation
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
- operations.tsp: "and endpoint" → "an endpoint" - responses.tsp: "fo" → "of", "being updated" → "being created" - decorators.tsp: "autoRout" → "autoRoute" - common-types/nsp-operations.tsp: removed ghost @template tags, "parameter" → "perimeter" - common-types/private-links-ref.tsp: "private endpoint" → "private link" - common-types/managed-identity-ref.tsp: "service-assigned" → "system-assigned" - legacy-types/operations.tsp: "form" → "from", "being patched" → "being listed" - legacy-types/private-endpoints.tsp: removed ghost @template tags - legacy-types/extension.tsp: "created or updated" → "updated" for PATCH ops Closes #5061 Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
microsoft-github-policy-service
Bot
added
lib:azure-resource-manager
Copilot
AI
changed the title
[WIP] Fix ARM library doc-comment typos and regenerate reference docs
Fix ARM library doc-comment typos and regenerate reference docs
Jul 27, 2026
markcowl
approved these changes
Jul 28, 2026
markcowl
marked this pull request as ready for review
July 28, 2026 00:43
commit: |
Contributor
|
You can try these changes here
|
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.
Corrects inaccurate doc comments across
typespec-azure-resource-manager.tspsource files and regenerates the reference docs they feed.Doc-comment fixes
lib/operations.tsp— "exposes and endpoint" → "an endpoint" (×2)lib/responses.tsp—ArmCombinedLroHeaders: "type fo the link" → "of";ArmResourceCreatedResponse/ArmResourceCreatedSyncResponse:@template Resource"being updated" → "being created"lib/decorators.tsp— "turns off autoRout" → "autoRoute"lib/common-types/nsp-operations.tsp— removed ghost@template ParentName/ParentFriendlyNametags not present in theListByParent/ListSinglePageByParentsignatures; "network security parameter" → "perimeter"lib/common-types/private-links-ref.tsp—PrivateLinkResource: "private endpoint resource" → "private link resource"lib/common-types/managed-identity-ref.tsp—SystemAssignedServiceIdentity: "service-assigned" → "system-assigned"lib/legacy-types/operations.tsp— "created form this template" → "from" (×2);ArmListSinglePageBySubscription/ArmListSinglePageByParent: "being patched" → "being listed"lib/legacy-types/private-endpoints.tsp— removed ghost@template ParentName/ParentFriendlyNametagslib/legacy-types/extension.tsp—CustomPatchAsync/CustomPatchSync: "being created or updated" → "being updated" (PATCH cannot create)Regenerated outputs
reference/data-types.md,reference/decorators.md,reference/interfaces.md,README.md, andgenerated-defs/Azure.ResourceManager.tsupdated viapnpm regen-docsto reflect the fixed comments.