From 92b51927955dabeeb10a13ccc88a9d2e7011fcbd Mon Sep 17 00:00:00 2001 From: "Jay S. Bryant" Date: Wed, 26 Jul 2017 10:45:02 -0500 Subject: [PATCH] [DOC BLD FIX] Fix docstring errors in reduxio The reduxio driver had docstring errors that were causing Sphinx to produce build WARNINGs. This change fixes those docstring problems. Change-Id: I41f50518cfe2be9790c8b655770b8a874bf8ab5b --- cinder/volume/drivers/reduxio/rdx_iscsi_driver.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/cinder/volume/drivers/reduxio/rdx_iscsi_driver.py b/cinder/volume/drivers/reduxio/rdx_iscsi_driver.py index 0f037333201..3a2b0a9c894 100644 --- a/cinder/volume/drivers/reduxio/rdx_iscsi_driver.py +++ b/cinder/volume/drivers/reduxio/rdx_iscsi_driver.py @@ -51,9 +51,13 @@ LOG = logging.getLogger(__name__) class ReduxioISCSIDriver(san.SanISCSIDriver): """OpenStack driver to support Reduxio storage systems. - Version history: - 1.0.0 - Initial version - volume management, snapshots, BackDating(TM). - 1.0.1 - Capacity stats, fixed error handling for volume deletions. + .. code-block:: default + + Version history: + 1.0.0 - Initial version - volume management, snapshots, + BackDating(TM). + 1.0.1 - Capacity stats, fixed error handling for volume deletions. + """ VERSION = '1.0.1' CI_WIKI_NAME = "Reduxio_HX550_CI" @@ -237,6 +241,7 @@ class ReduxioISCSIDriver(san.SanISCSIDriver): """Clone volume from existing cinder volume. :param volume: The clone volume object. + If the volume 'metadata' field contains a 'backdate' key (If using Cinder CLI, should be provided by --meta flag), then we create a clone from the specified time. @@ -249,6 +254,7 @@ class ReduxioISCSIDriver(san.SanISCSIDriver): If meta key 'backdate' was not specified, then we create a clone from the volume's current state. + :param src_vref: The source volume to clone from :return: None """ @@ -285,6 +291,7 @@ class ReduxioISCSIDriver(san.SanISCSIDriver): We use Reduxio manual bookmark to represent a snapshot. :param snapshot: The snapshot object. + If the snapshot 'metadata' field contains a 'backdate' key (If using Cinder CLI, should be provided by --meta flag), then we create a snapshot from the specified time. @@ -297,6 +304,7 @@ class ReduxioISCSIDriver(san.SanISCSIDriver): If meta key 'backdate' was not specified, then we create a snapshot from the volume's current state. + :return: None """ LOG.info(