Complete docstring

Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/e5a69865
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/e5a69865
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/e5a69865

Branch: refs/heads/trunk
Commit: e5a69865a0f00d545158a2e593e6c034ea153337
Parents: 33728b2
Author: micafer <[email protected]>
Authored: Wed Nov 28 16:03:39 2018 +0100
Committer: Rick van de Loo <[email protected]>
Committed: Tue Dec 4 09:45:48 2018 +0100

----------------------------------------------------------------------
 libcloud/compute/drivers/openstack.py | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/e5a69865/libcloud/compute/drivers/openstack.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/openstack.py 
b/libcloud/compute/drivers/openstack.py
index f244f91..3aebda3 100644
--- a/libcloud/compute/drivers/openstack.py
+++ b/libcloud/compute/drivers/openstack.py
@@ -3064,10 +3064,23 @@ class OpenStack_2_NodeDriver(OpenStack_1_1_NodeDriver):
         return self._to_port(response.object['port'])
 
     def list_volumes(self):
+        """
+        Get a list of Volumes that are available.
+
+        :rtype: ``list`` of :class:`StorageVolume`
+        """
         return self._to_volumes(
             self.volumev2_connection.request('/volumes/detail').object)
 
     def ex_get_volume(self, volumeId):
+        """
+        Retrieve the StorageVolume with the given ID
+
+        :param volumeId: ID of the volume
+        :type volumeId: ``string``
+
+        :return: :class:`StorageVolume`
+        """
         return self._to_volume(
             self.volumev2_connection.request('/volumes/%s' % volumeId).object)
 
@@ -3122,10 +3135,23 @@ class OpenStack_2_NodeDriver(OpenStack_1_1_NodeDriver):
         return self._to_volume(resp.object)
 
     def destroy_volume(self, volume):
+        """
+        Delete a Volume.
+
+        :param volume: Volume to be deleted
+        :type  volume: :class:`StorageVolume`
+
+        :rtype: ``bool``
+        """
         return self.volumev2_connection.request('/volumes/%s' % volume.id,
                                                 method='DELETE').success()
 
     def ex_list_snapshots(self):
+        """
+        Get a list of Snapshot that are available.
+
+        :rtype: ``list`` of :class:`VolumeSnapshot`
+        """
         return self._to_snapshots(
             self.volumev2_connection.request('/snapshots/detail').object)
 

Reply via email to