azure-cli icon indicating copy to clipboard operation
azure-cli copied to clipboard

[Reference freshness project] Resource (`az group`, `az account-management`...)

Open dbradish-microsoft opened this issue 2 years ago • 4 comments

This PR is part of the reference refresh project. This PR focuses on src/azure-cli/azure/cli/command_modules/resource/_help.py and any related file containing summaries or examples for these same command groups.

The updates in this PR are intended to freshen the following reference areas:

  1. short-summary
  2. long-summary
  3. examples

Note: The testing of all examples is out of scope for this project and is part of the Content Quality Automation crew project.

This is work item https://dev.azure.com/mseng/TechnicalContent/_workitems/edit/1998772.

dbradish-microsoft avatar Oct 24 '22 22:10 dbradish-microsoft

@zhoxing-ms for awareness

yonzhan avatar Oct 25 '22 00:10 yonzhan

@zhoxing-ms , friendly FYI that I've put the parameter information back into the _help.py file.

Question, does it matter to you if the --name: and sub information is left justified, like this: image

The above updates were per @jiasli 's request in PR https://github.com/Azure/azure-cli/pull/24332/files

dbradish-microsoft avatar Nov 09 '22 20:11 dbradish-microsoft

Question, does it matter to you if the --name: and sub information is left justified, like this:

Personally, I think there is no problem. In fact, both methods are used in CLI.

zhoxing-ms avatar Nov 10 '22 02:11 zhoxing-ms

@zhoxing-ms , "Personally, I think there is no problem. In fact, both methods are used in CLI."

I personally feel the green box above it is more difficult to read. So, with your feedback, I am not going to put myself in the reformatting business. :-) I'll leave well enough alone in this file.

dbradish-microsoft avatar Nov 10 '22 14:11 dbradish-microsoft

I am giving the methodology for freshening azCLI autogen reference content, and consequently this PR, a necessary ending in order to make way for new beginnings.

dbradish-microsoft avatar Feb 02 '23 05:02 dbradish-microsoft