Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update azure_rm_manageddisk Doc to reflect return value #616

Merged
merged 4 commits into from
Sep 6, 2021

Conversation

nbr23
Copy link
Contributor

@nbr23 nbr23 commented Aug 26, 2021

SUMMARY

The azure_rm_manageddisk documentation for the module's return value is incorrect. This fixes the documentation to match reality.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
  • azure_rm_manageddisk
ADDITIONAL INFORMATION

The azure_rm_manageddisk documentation mentions a return dict of this shape:

{
 'id': diskid
 'state': disk_state
 'changed': true
}

However, the 'id' field is not present in the return value and must be fetched from the 'state' field. This PR removes 'id' as a field from the description, and adds a list of the fields present in 'state'.

The tests already reflect this, no update needed.

@Fred-sun Fred-sun added documentation-pr Improvements or additions to documentation medium_priority Medium priority work in In trying to solve, or in working with contributors labels Aug 27, 2021
@Fred-sun Fred-sun added ready_for_review The PR has been modified and can be reviewed and merged and removed work in In trying to solve, or in working with contributors labels Aug 30, 2021
@xuzhang3
Copy link
Collaborator

xuzhang3 commented Sep 6, 2021

LGTM

@xuzhang3 xuzhang3 merged commit ce15fe5 into ansible-collections:dev Sep 6, 2021
nbr23 added a commit to nbr23/azure that referenced this pull request Oct 26, 2021
…ections#616)

* Update azure_rm_manageddisk Doc to reflect return value

* Fix os_type return value doc in manageddisk

Co-authored-by: xuzhang3 <57888764+xuzhang3@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation-pr Improvements or additions to documentation medium_priority Medium priority ready_for_review The PR has been modified and can be reviewed and merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants