openstack/python-cinderclient
Code Issues Proposed changes

Correct param comments in docstring

Browse Source 
Some methods in cinderclient/v1/volumes.VolumeManager have 'volume'
paramter, but in docstring the paramter is 'server'. So change ":param
server:" to ":param volume:".

Change-Id: I75a86180a830d3ae875ee1aecd45f9a6e39f6e22
This commit is contained in:
Rongze Zhu
2012-08-23 16:55:43 +00:00
parent 0bba3857d1
commit 0e1e44733b
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cinderclient/v1/volumes.py
View File

@@ -230,7 +230,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Set attachment metadata.
:param server: The :class:`Volume` (or its ID)
:param volume: The :class:`Volume` (or its ID)
you would like to attach.
:param instance_uuid: uuid of the attaching instance.
:param mountpoint: mountpoint on the attaching instance.
@@ -244,7 +244,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Clear attachment metadata.
:param server: The :class:`Volume` (or its ID)
:param volume: The :class:`Volume` (or its ID)
you would like to detach.
"""
return self._action('os-detach', volume)
@@ -253,7 +253,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Reserve this volume.
:param server: The :class:`Volume` (or its ID)
:param volume: The :class:`Volume` (or its ID)
you would like to reserve.
"""
return self._action('os-reserve', volume)
@@ -262,7 +262,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Unreserve this volume.
:param server: The :class:`Volume` (or its ID)
:param volume: The :class:`Volume` (or its ID)
you would like to unreserve.
"""
return self._action('os-unreserve', volume)
@@ -271,7 +271,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Initialize a volume connection.
:param server: The :class:`Volume` (or its ID).
:param volume: The :class:`Volume` (or its ID).
:param connector: connector dict from nova.
"""
return self._action('os-initialize_connection', volume,
@@ -281,7 +281,7 @@ class VolumeManager(base.ManagerWithFind):
"""
Terminate a volume connection.
:param server: The :class:`Volume` (or its ID).
:param volume: The :class:`Volume` (or its ID).
:param connector: connector dict from nova.
"""
self._action('os-terminate_connection', volume,