Feature/centralize doc fragments #86
Closed
+62
−109
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
This is preparing the pymomi module utils to be made public. The main change here is cleaning up the doc fragments. Eventually, we can combine the rest and pyvmomi doc fragments. The only significant differences between them is
protocol
parameterSo far in this repo, the cluster/datacenter documentation is re-written in every module so its not needed in the doc frag. I think thats a good trend to carry on going forward, and it has the added benefit of making the writer consider if cluster and datacenter are required, optional, or unused in their module.
The protocol parameter is unused by pyvmomi, but I dont think theres any harm in including it. Iit makes our lives easier since we dont need to maintain two copies of the doc frag thats 95% redundant. And theres no harm in the user setting it for pyvmomi since that SDK automatically determines the protocol anyway
This change does not update the REST utils doc fragments, that should come later
ISSUE TYPE
COMPONENT NAME
module_utils/_vmware doc fragments