Improve Docs In azure_rm_virtualnetwork
#1203
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fred-sun
reviewed
Jul 3, 2023
| @@ -218,7 +222,7 @@ def __init__(self): | |||
| state=dict(type='str', default='present', choices=['present', 'absent']), | |||
| location=dict(type='str'), | |||
| address_prefixes_cidr=dict(type='list', aliases=['address_prefixes']), | |||
There was a problem hiding this comment.
Suggested change
| address_prefixes_cidr=dict(type='list', aliases=['address_prefixes']), | |
| address_prefixes_cidr=dict(type='list', elements='str', aliases=['address_prefixes']), |
There was a problem hiding this comment.
@Fred-sun I've updated the code to reflect this change. Thank you for the comment!
| @@ -218,7 +222,7 @@ def __init__(self): | |||
| state=dict(type='str', default='present', choices=['present', 'absent']), | |||
| location=dict(type='str'), | |||
| address_prefixes_cidr=dict(type='list', aliases=['address_prefixes']), | |||
| dns_servers=dict(type='list',), | |||
| dns_servers=dict(type='list'), | |||
There was a problem hiding this comment.
Suggested change
| dns_servers=dict(type='list'), | |
| dns_servers=dict(type='list', elements='str'), |
There was a problem hiding this comment.
@Fred-sun I've updated the code to reflect this change. Thank you for the comment!
Fred-sun
added
medium_priority
* The DNS Servers should be a list of strings * Remove the trailing comma in the `dict()` call for `dns_servers` * The boolean values should default to a boolean value in the docs * Clean up excess quotation in some of the examples
* Incorporate PR feedback from @Fred-sun correctly indicated that I didn't apply the elements parameter to the argument spec for `address_prefixes_cidr` and `dns_servers` * This helps Ansible validate the list elements are the correct type for the 2 affected module parameters
timway
force-pushed
the
vnet-dns-server-doc-tweaks
branch
from
7e1ef70
to
d2d4edf
Compare
|
@timway Please delete the corresponding line in the following file |
timway
force-pushed
the
vnet-dns-server-doc-tweaks
branch
from
b6432e2
to
d2d4edf
Compare
|
@timway Please update the corresponding Ignore*.txt, because we added elements in document and args, which should be deleted （ignore line)accordingly! Thank you very much! |
* As @Fred-sun pointed out a number of the sanity tests no longer need to ignore a failure condition with this PR
|
kindly ping! |
|
@Fred-sun I believe I addressed the ignores in the most recent commit. |
|
@timway Sorry, it has been added, I will push forward the merge. |
|
@xuzhang3 ready_for_review |
Fred-sun
added
ready_for_review
xuzhang3
approved these changes
Jul 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
dict()call fordns_serversISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION