Skip to content

{image-copy} Update help - #1560

Merged
Feiyue Yu (qwordy) merged 4 commits into
Azure:masterfrom
qwordy:image-copy
Apr 21, 2020
Merged

{image-copy} Update help#1560
Feiyue Yu (qwordy) merged 4 commits into
Azure:masterfrom
qwordy:image-copy

Conversation

@qwordy

@qwordy Feiyue Yu (qwordy) commented Apr 20, 2020

Copy link
Copy Markdown
Member

#1254
Add "Keep in mind that it requires the source disk to be available."
Long summary is not shown in HTML doc. And Doc team is not willing to fix it.

This logic did not change for quite a long time, which was designed to hide long summary long time ago(2 years ago) as many long summary was empty or duplicate as short summary at that time.


This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally?

For new extensions:

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your PR is merged into master branch, a new PR will be created to update src/index.json automatically.
The precondition is to put your code inside this repo and upgrade the version in the PR but do not modify src/index.json.

@yonzhan

Copy link
Copy Markdown
Collaborator

add to S169

Comment thread src/image-copy/azext_imagecopy/_help.py Outdated
helps['image copy'] = """
type: command
short-summary: Copy a managed image (or vm) to other regions
short-summary: Copy a managed image (or vm) to other regions. Keep in mind that it requires the source disk to be available.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove Keep in mind that to keep it short? You could probably remove the long summary as well since it basically repeats the short summary now.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea

Comment thread src/image-copy/azext_imagecopy/_help.py Outdated
@qwordy
Feiyue Yu (qwordy) merged commit 17b6c96 into Azure:master Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants