consolidate argument specs and doc fragments #89
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
mikemorency
force-pushed
the
feature/consolidate-arg-specs-and-docs
branch
from
9d32d91 to
6a60822
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #89 +/- ##
==========================================
+ Coverage 27.48% 28.03% +0.54%
==========================================
Files 24 25 +1
Lines 2059 2076 +17
Branches 385 385
==========================================
+ Hits 566 582 +16
- Misses 1493 1494 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
mikemorency
requested review from
shellymiron,
elsapassaro,
anna-savina,
bardielle and
machacekondra
as code owners
This was referenced Dec 11, 2024
Closed
anna-savina
reviewed
Dec 11, 2024
| proxy_protocol: | ||
| description: | ||
| - The proxy connection protocol to use. | ||
| - This is option is used if the correct proxy protocol cannot be automatically determined. |
There was a problem hiding this comment.
Suggested change
| - This is option is used if the correct proxy protocol cannot be automatically determined. | |
| - This option is used if the correct proxy protocol cannot be automatically determined. |
anna-savina
reviewed
Dec 11, 2024
| # This vmware.vmware.base_options fragment covers the arg spec provided by the base_argument_spec() function | ||
| DOCUMENTATION = r''' | ||
| notes: | ||
| - All modules require API write access and hence is not supported on a free ESXi license. |
There was a problem hiding this comment.
Suggested change
| - All modules require API write access and hence is not supported on a free ESXi license. | |
| - All modules require API write access and hence are not supported on a free ESXi license. |
anna-savina
reviewed
Dec 11, 2024
| default: 443 | ||
| proxy_host: | ||
| description: | ||
| - Address of a proxy that will receive all HTTPS requests and relay them. |
There was a problem hiding this comment.
Suggested change
| - Address of a proxy that will receive all HTTPS requests and relay them. | |
| - The address of a proxy that will receive all HTTPS requests and relay them. |
anna-savina
reviewed
Dec 11, 2024
| required: false | ||
| proxy_port: | ||
| description: | ||
| - Port of the HTTP proxy that will receive all HTTPS requests and relay them. |
There was a problem hiding this comment.
Suggested change
| - Port of the HTTP proxy that will receive all HTTPS requests and relay them. | |
| - The port of the HTTP proxy that will receive all HTTPS requests and relay them. |
anna-savina
reviewed
Dec 11, 2024
| """ | ||
| This returns a dictionary that can be used as the baseline for all REST module specs. | ||
| If your module uses the REST API, you should use this instead of the base_argument_spec. | ||
| If your module uses both this and the pyvmomi SDK, you should still use this spec. |
There was a problem hiding this comment.
Suggested change
| If your module uses both this and the pyvmomi SDK, you should still use this spec. | |
| If your module uses both this spec and the pyvmomi SDK, you should still use this spec. |
anna-savina
reviewed
Dec 11, 2024
|
|
||
| def base_argument_spec(): | ||
| """ | ||
| This returns a dictionary that can be used as the baseline for all vmware module specs. Any arguments |
There was a problem hiding this comment.
Suggested change
| This returns a dictionary that can be used as the baseline for all vmware module specs. Any arguments | |
| This returns a dictionary that can be used as the baseline for all VMware module specs. Any arguments |
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
Combining #86 and #87
This removes instances of repeated option documentation and redundant spec args.
ISSUE TYPE
COMPONENT NAME
doc fragments
argument specs
ADDITIONAL INFORMATION
While I was working on this, I found the kubernetes collection has a pretty nice pattern for breaking out the doc fragments. I tried to copy theirs, https://github.com/ansible-collections/kubernetes.core/tree/main/plugins/doc_fragments
Similar pattern for the arg specs too https://github.com/ansible-collections/kubernetes.core/blob/main/plugins/module_utils/args_common.py