{MySQL} Update server update help doc format#32190
Merged
Conversation
️✔️AzureCLI-FullTest
|
|
Hi @honghr, |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the YAML formatting in the MySQL flexible server update command help documentation to ensure the warning note renders properly in the Azure CLI reference documentation.
- Updates the YAML style indicator from ">" (folded style) to "|" (literal style) for the long-summary field
- This change preserves newlines in the warning message instead of collapsing them into spaces
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
️✔️AzureCLI-BreakingChangeTest
|
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
evelyn-ys
approved these changes
Oct 22, 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.
Related command
Description
Fix this #31641
Update server update help doc format.
The "Warning" note in the reference document for "_help.py" is not rendered properly.
This is due to the ">" after "long-summary:" in YAML indicates a folded style, which collapses newlines into spaces. Recommended fix: use "|" or refer to yaml standards to update in "_help.py".
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.