[
https://issues.apache.org/jira/browse/LIBCLOUD-892?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15866515#comment-15866515
]
Russell Tolle commented on LIBCLOUD-892:
----------------------------------------
Fixed doc strings that were copied, but not updated to the correct parameter.
Description
I fixed the doc strings of the following functions:
ex_copy_image
the url param annotation was being used as the type annotation
ex_create_image
the keyword annotation was typo'd to keywork.
ex_delete_access_config
the name keyword's type annotation was copied from node.
ex_get_image
the ex_project_list parameter's type annotation was using ',' instead of 'or'
for multiple types.
ex_get_license
There were two annotations for name when the project annotation was missing.
ex_get_subnetwork
There were two annotations for name when the region annotation was missing.
ex_instancegroup_list_instances
The instancegroup type annotation was using double back ticks around the type
instead of single ticks.
ex_destroy_subnetwork
There were two annotations for name when the region annotation was missing.
Status
done, ready for review
> Improve GCE compute driver documentation.
> -----------------------------------------
>
> Key: LIBCLOUD-892
> URL: https://issues.apache.org/jira/browse/LIBCLOUD-892
> Project: Libcloud
> Issue Type: Improvement
> Components: Compute
> Reporter: Russell Tolle
> Priority: Trivial
> Labels: documentation, easyfix, newbie
> Original Estimate: 0.5h
> Remaining Estimate: 0.5h
>
> Copied and pasted docstrings that weren't updated for the parameter/keyword
> they represent.
> The list of affected functions:
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_copy_image
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_create_image
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_delete_access_config
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_get_image
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_get_license
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_get_subnetwork
> http://libcloud.readthedocs.io/en/stable/apidocs/libcloud.compute.drivers.html#libcloud.compute.drivers.gce.GCENodeDriver.ex_get_subnetwork
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
