openstack
/
deb-cinder
Code Issues Proposed changes

[DOC BLD FIX] Fix docstring issues in dothill driver 

As with other drivers the version history at the top of the
dothill driver was causing Sphinx build WARNINGs to be issued.
This changes puts the version history in a text box for better
readability and to avoid the WARNING.

Change-Id: I387ae425e3a2a1e37264589bb33a0acdcf61ca9a
This commit is contained in:
Jay S. Bryant 2017-07-24 11:23:41 -05:00
parent 212b045a02
commit 48ff447f6a
2 changed files with 36 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
cinder/volume/drivers/dothill/dothill_fc.py
View File

@ -30,6 +30,8 @@ from cinder.zonemanager import utils as fczm_utils
class DotHillFCDriver(cinder.volume.driver.FibreChannelDriver):
"""OpenStack Fibre Channel cinder drivers for DotHill Arrays.
.. code:: text
Version history:
0.1 - Base version developed for HPMSA FC drivers:
"https://github.com/openstack/cinder/tree/stable/juno/
@ -44,6 +46,7 @@ class DotHillFCDriver(cinder.volume.driver.FibreChannelDriver):
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
"""
def __init__(self, *args, **kwargs):

3
cinder/volume/drivers/dothill/dothill_iscsi.py
View File

@ -36,6 +36,8 @@ LOG = logging.getLogger(__name__)
class DotHillISCSIDriver(cinder.volume.driver.ISCSIDriver):
"""OpenStack iSCSI cinder drivers for DotHill Arrays.
.. code:: text
Version history:
0.1 - Base structure for DotHill iSCSI drivers based on HPMSA FC
drivers:
@ -52,6 +54,7 @@ class DotHillISCSIDriver(cinder.volume.driver.ISCSIDriver):
1.6 - Add management path redundancy and reduce load placed
on management controller.
1.7 - Modified so it can't be invoked except as a superclass
"""
def __init__(self, *args, **kwargs):