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

Correct documentation of return attribute for azure_rm_webapp #846

Merged
merged 1 commit into from
May 13, 2022

Conversation

l3ender
Copy link
Contributor

@l3ender l3ender commented May 10, 2022

SUMMARY

The documentation for azure_rm_webapp states the return attribute is azure_webapp, when it is actually id.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

azure_rm_webapp

@l3ender
Copy link
Contributor Author

l3ender commented May 10, 2022

@Fred-sun @xuzhang3 This is a quick documentation fix. Thank you!

@Fred-sun
Copy link
Collaborator

@l3ender Thank you for your contribution to the repo. The module only returns this ID when managing resources, so it makes sense. Of course, there should be a more detailed return value. It is recommended to update the module return value first. Then update the document return value. Thank you very much!

Like this:
834 line adds: self.results['azure_webapp'] = webapp
Then install the link below to update the return value. 
Link: https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html

@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 May 11, 2022
@l3ender
Copy link
Contributor Author

l3ender commented May 11, 2022

@Fred-sun Changing the functionality of the module and its return values is out of scope of this PR. This is a simple change to correct an issue in the documentation. Thank you.

@l3ender l3ender changed the title Correct return attribute for azure_rm_webapp Correct documentation of return attribute for azure_rm_webapp May 11, 2022
@Fred-sun
Copy link
Collaborator

@l3ender But the return value of the module is ”ID“, not azure_webapp. Thank you!

@l3ender
Copy link
Contributor Author

l3ender commented May 13, 2022

@l3ender But the return value of the module is ”ID“, not azure_webapp. Thank you!

I'm not sure what you are asking about as this PR is to update the documentation to id, as you mentioned. Please share more detail on what you mean. Thank you!

@Fred-sun
Copy link
Collaborator

@l3ender I'm sorry that I misread your change "id--> azure_webapp"! You're right. I'm pushing the merger as fast as I can! . Thank you very much!

@Fred-sun Fred-sun added the ready_for_review The PR has been modified and can be reviewed and merged label May 13, 2022
@xuzhang3
Copy link
Collaborator

LGTM 🚀

@xuzhang3 xuzhang3 merged commit 82e252e into ansible-collections:dev May 13, 2022
@xuzhang3 xuzhang3 deleted the webapp-return branch May 13, 2022 03:48
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 work in In trying to solve, or in working with contributors
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants