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_networkinterface related document #57454

Merged
merged 5 commits into from Jun 17, 2019

Conversation

Projects
None yet
3 participants
@Fred-sun
Copy link
Contributor

commented Jun 6, 2019

SUMMARY

Update azure_rm_networkinterface related document.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

azure_rm_networkinterface/azure_rm_networkinterface_facts

ADDITIONAL INFORMATION

@ansibot

This comment has been minimized.

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 6, 2019

@Fred-sun, just so you are aware we have a dedicated Working Group for azure.
You can find other people interested in this in #ansible-azure on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jun 6, 2019

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or buffer

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or buffer

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test ansible-doc --python 3.8 [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: missing documentation (or could not parse documentation): expected string or bytes-like object

The test ansible-test sanity --test pep8 [explain] failed with 2 errors:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:407:161: E501 line too long (194 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:431:161: E501 line too long (164 > 160 characters)

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:0:0: E305 DOCUMENTATION.options.private_ip_allocation_method.description.1: expected str @ data['options']['private_ip_allocation_method']['description'][1]. Got {'NOTE': 'When creating a network interface specifying a value of C(Static) requires that a I(private_ip_address) value be provided.'}
lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:454:5: E313 RETURN is not valid YAML

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/cloud/azure/azure_rm_networkinterface.py:454:5: error RETURN: syntax error: expected <block end>, but found '}'

click here for bot help

@acozine
Copy link
Contributor

left a comment

Thanks @Fred-sun for updating this documentation. I found a few typos and other small changes to suggest on this PR.

I'm curious, why are you adding quotation marks around the version_added numbers? They display fine without them, and we've been removing them from other module docs. See this screenshot from the devel docs for azure_rm_networkinterface:

Screen Shot 2019-06-10 at 10 23 17 AM

I'd recommend leaving the version_added numbers without " or ' around them.

@ansibot ansibot removed the needs_triage label Jun 10, 2019

@Fred-sun

This comment has been minimized.

Copy link
Contributor Author

commented Jun 11, 2019

Thanks @Fred-sun for updating this documentation. I found a few typos and other small changes to suggest on this PR.
I'm curious, why are you adding quotation marks around the version_added numbers? They display fine without them, and we've been removing them from other module docs. See this screenshot from the devel docs for azure_rm_networkinterface:

I'd recommend leaving the version_added numbers without " or ' around them.

Thanks for your review. This is required from the format of the module, you can find the answer in this link!

  1. Only needed if this option was extended after initial Ansible release, i.e. this is greater than the top level version_added field.
  2. This is a string, and not a float, i.e. version_added: '2.3'.
Delete set nu
Delete set nu
@Fred-sun

This comment has been minimized.

Copy link
Contributor Author

commented Jun 11, 2019

ready_for_review

@acozine acozine merged commit 6e89fbe into ansible:devel Jun 17, 2019

1 check passed

Shippable Run 128042 status is SUCCESS.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.