Merge "Fix docstring warnings"

ironic/common/fsm.py

@@ -70,7 +70,7 @@ class FSM(machines.FiniteMachine):
 
         :param state: the state of interest
         :raises: InvalidState if the state is invalid
-        :returns True if it is a stable state; False otherwise
+        :returns: True if it is a stable state; False otherwise
         """
         try:
             return self._states[state]['stable']

ironic/dhcp/neutron.py

@@ -101,16 +101,17 @@ class NeutronDHCPApi(base.BaseDHCP):
                           {'opt_name': 'tftp-server',
                            'opt_value': '123.123.123.123'}]
         :param vifs: a dict of Neutron port/portgroup dicts
-            to update DHCP options on. The port/portgroup dict key
+                     to update DHCP options on. The port/portgroup dict
-            should be Ironic port UUIDs, and the values should be
+                     key should be Ironic port UUIDs, and the values
-            Neutron port UUIDs, e.g.
+                     should be Neutron port UUIDs, e.g.
 
                      ::
 
                       {'ports': {'port.uuid': vif.id},
                        'portgroups': {'portgroup.uuid': vif.id}}
-            If the value is None, will get the list of ports/portgroups
+                      If the value is None, will get the list of
-            from the Ironic port/portgroup objects.
+                      ports/portgroups from the Ironic port/portgroup
+                      objects.
         """
         if vifs is None:
             vifs = network.get_node_vif_ids(task)

ironic/drivers/modules/agent_client.py

@@ -139,8 +139,8 @@ class AgentClient(object):
         :param iqn: iSCSI target IQN
         :param portal_port: iSCSI portal port
         :param wipe_disk_metadata: True if the agent should wipe first the
-        disk magic strings like the partition table, RAID or filesystem
+                                   disk magic strings like the partition
-        signature.
+                                   table, RAID or filesystem signature.
         """
         params = {'iqn': iqn}
         # This is to workaround passing default values to an old ramdisk

ironic/drivers/modules/drac/management.py

@@ -156,11 +156,11 @@ class DracManagement(base.ManagementInterface):
         :param task: a TaskManager instance containing the node to act on.
         :raises: DracOperationError on an error from python-dracclient.
         :returns: a dictionary containing:
+
             :boot_device: the boot device, one of
                 :mod:`ironic.common.boot_devices` or None if it is unknown.
-            :persistent: whether the boot device will persist to all
+            :persistent: whether the boot device will persist to all future
-                future boots or not, None if it is unknown.
+                boots or not, None if it is unknown.
-
         """
         node = task.node
 
@@ -214,6 +214,5 @@ class DracManagement(base.ManagementInterface):
         :raises: FailedToParseSensorData when parsing sensor data fails.
         :returns: returns a consistent format dict of sensor data grouped by
                   sensor type, which can be processed by Ceilometer.
-
         """
         raise NotImplementedError()

ironic/drivers/modules/irmc/inspect.py

@@ -59,6 +59,7 @@ sc2UnitNodeClass OBJECT-TYPE
  baseboard-controller:    local baseboard management controller (BMC)"
  ::= { sc2ManagementNodes 8 }
 """
+
 NODE_CLASS_OID_VALUE = {
     'unknown': 1,
     'primary': 2,
@@ -81,6 +82,7 @@ sc2UnitNodeMacAddress OBJECT-TYPE
  DESCRIPTION  "Management node hardware (MAC) address"
  ::= { sc2ManagementNodes 9 }
 """
+
 MAC_ADDRESS_OID = '1.3.6.1.4.1.231.2.10.2.2.10.3.1.1.9.1'
 
 

setup.cfg

@@ -103,6 +103,7 @@ autodoc_index_modules = True
 autodoc_exclude_modules =
     ironic.db.sqlalchemy.alembic.env
     ironic.db.sqlalchemy.alembic.versions.*
+warnerrors = True
 
 [build_sphinx]
 all_files = 1