Improve TSDoc documentation for Azure Cloud helpers#3474
Merged
Conversation
Copilot
AI
changed the title
[WIP] Improve TSDoc documentation
Improve TSDoc documentation for Azure Cloud helpers
Aug 26, 2025
Member
|
@copilot for ci error, fix according to the following steps:
|
Co-authored-by: v-jiaodi <80496810+v-jiaodi@users.noreply.github.com>
Contributor
Author
I've successfully completed all the requested steps to fix the CI error:
The CI error has been resolved. The changes include updated package.json exports configuration and a new API review file. Commit: 9ff6ac9 |
v-jiaodi
approved these changes
Aug 26, 2025
MaryGao
approved these changes
Aug 26, 2025
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.
Enhanced the TSDoc documentation in
cloudSettingHelpers.tsto provide better developer experience and IntelliSense support.Changes Made
Enhanced Enum Documentation
@enum {string}TSDoc tag toAzureCloudsenumComplete Function Documentation
getArmEndpointfunction with:@param cloudSetting- Clear description of the parameter and expected values@returns- Documentation of return value including undefined case@throws {Error}- Documentation of error conditions when invalid cloud setting is providedExample of Generated Output
The improved documentation now generates code that matches the expected format:
This provides better IntelliSense support and clearer documentation for developers using the generated Azure SDK client libraries.
Fixes #3473.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.