PEP 257 fixes

2 files changed, 38 insertions, 26 deletions

diff --git a/nova/volume/driver.py b/nova/volume/driver.py
index 22c2c2fc3..4263a6a8d 100644
--- a/nova/volume/driver.py
+++ b/nova/volume/driver.py
@@ -227,14 +227,16 @@ class FakeAOEDriver(AOEDriver):
 
 
 class ISCSIDriver(VolumeDriver):
-    """Executes commands relating to ISCSI volumes. We make use of model
-    provider properties as follows:
-    provider_location - if present, contains the iSCSI target information
-    in the same format as an ietadm discovery
-    i.e. '<target ip/port>,<target portal> <target IQN>'
-    provider_auth - if present, contains a space-separated triple:
-    '<auth method> <auth username> <auth password>'.  CHAP is the only
-    auth_method in use at the moment."""
+    """Executes commands relating to ISCSI volumes.
+
+    We make use of model provider properties as follows:
+    :provider_location:    if present, contains the iSCSI target information
+                           in the same format as an ietadm discovery
+                           i.e. '<ip>:<port>,<portal> <target IQN>'
+    :provider_auth:    if present, contains a space-separated triple:
+                       '<auth method> <auth username> <auth password>'.
+                       `CHAP` is the only auth_method in use at the moment.
+    """
 
     def ensure_export(self, context, volume):
         """Synchronously recreates an export for a logical volume."""
@@ -321,17 +323,19 @@ class ISCSIDriver(VolumeDriver):
         return None
 
     def _get_iscsi_properties(self, volume):
-        """Gets iscsi configuration, ideally from saved information in the
-        volume entity, but falling back to discovery if need be. The
-        properties are:
-            target_discovered - boolean indicating whether discovery was used,
-            target_iqn - the IQN of the iSCSI target,
-            target_portal - the portal of the iSCSI target,
-            and auth_method, auth_username and auth_password
-                - the authentication details. Right now, either
-                auth_method is not present meaning no authentication, or
-                auth_method == 'CHAP' meaning use CHAP with the specified
-                credentials."""
+        """Gets iscsi configuration
+
+        We ideally get saved information in the volume entity, but fall back
+        to discovery if need be. Discovery may be completely removed in future
+        The properties are:
+        :target_discovered:    boolean indicating whether discovery was used
+        :target_iqn:    the IQN of the iSCSI target,
+        :target_portal:    the portal of the iSCSI target
+        :auth_method:, :auth_username:, :auth_password:
+            the authentication details. Right now, either auth_method is not
+            present meaning no authentication, or auth_method == `CHAP`
+            meaning use CHAP with the specified credentials.
+        """
 
         properties = {}
 
diff --git a/nova/volume/san.py b/nova/volume/san.py
index 09192bc9f..d6598d16e 100644
--- a/nova/volume/san.py
+++ b/nova/volume/san.py
@@ -16,8 +16,9 @@
 #    under the License.
 """
 Drivers for san-stored volumes.
+
 The unique thing about a SAN is that we don't expect that we can run the volume
- controller on the SAN hardware.  We expect to access it over SSH or some API.
+controller on the SAN hardware.  We expect to access it over SSH or some API.
 """
 
 import os
@@ -51,7 +52,11 @@ flags.DEFINE_integer('san_ssh_port', 22,
 
 class SanISCSIDriver(ISCSIDriver):
     """ Base class for SAN-style storage volumes
-        (storage providers we access over SSH)"""
+
+    A SAN-style storage value is 'different' because the volume controller
+    probably won't run on it, so we need to access is over SSH or another
+    remote protocol.
+    """
 
     def _build_iscsi_target_name(self, volume):
         return "%s%s" % (FLAGS.iscsi_target_prefix, volume['name'])
@@ -137,6 +142,7 @@ def _get_prefixed_values(data, prefix):
 
 class SolarisISCSIDriver(SanISCSIDriver):
     """Executes commands relating to Solaris-hosted ISCSI volumes.
+
     Basic setup for a Solaris iSCSI server:
     pkg install storage-server SUNWiscsit
     svcadm enable stmf
@@ -330,13 +336,14 @@ class SolarisISCSIDriver(SanISCSIDriver):
 
 class HpSanISCSIDriver(SanISCSIDriver):
     """Executes commands relating to HP/Lefthand SAN ISCSI volumes.
+
     We use the CLIQ interface, over SSH.
 
     Rough overview of CLIQ commands used:
-    CLIQ createVolume (creates the volume)
-    CLIQ getVolumeInfo (to discover the IQN etc)
-    CLIQ getClusterInfo (to discover the iSCSI target IP address)
-    CLIQ assignVolumeChap (exports it with CHAP security)
+    :createVolume:    (creates the volume)
+    :getVolumeInfo:    (to discover the IQN etc)
+    :getClusterInfo:    (to discover the iSCSI target IP address)
+    :assignVolumeChap:    (exports it with CHAP security)
 
     The 'trick' here is that the HP SAN enforces security by default, so
     normally a volume mount would need both to configure the SAN in the volume
@@ -344,7 +351,8 @@ class HpSanISCSIDriver(SanISCSIDriver):
     not catered for at the moment in the nova architecture, so instead we
     share the volume using CHAP at volume creation time.  Then the mount need
     only use those CHAP credentials, so can take place exclusively in the
-    compute layer"""
+    compute layer.
+    """
 
     def _cliq_run(self, verb, cliq_args):
         """Runs a CLIQ command over SSH, without doing any result parsing"""