Merge "Fix a few docstring warnings"

doc/source/index.rst

@@ -109,7 +109,7 @@ the developer community about any implementation using this functionality.
   :maxdepth: 1
 
   Driver Overview <dev/drivers>
-  Driver Base Class Definition <api/ironic.drivers.base.html>
+  Driver Base Class Definition <api/ironic.drivers.base>
   Writing "vendor_passthru" methods <dev/vendor-passthru>
   Third party continuous integration testing <dev/third-party-ci>
 

ironic/api/controllers/v1/port.py

@@ -627,7 +627,7 @@ class PortsController(rest.RestController):
         """Delete a port.
 
         :param port_uuid: UUID of a port.
-        :raises OperationNotPermitted, HTTPNotFound
+        :raises: OperationNotPermitted, HTTPNotFound
         """
         context = pecan.request.context
         cdict = context.to_policy_values()

ironic/objects/notification.py

@@ -100,8 +100,8 @@ class NotificationBase(base.IronicObject):
     def emit(self, context):
         """Send the notification.
 
-           :raises NotificationPayloadError
-           :raises oslo_versionedobjects.exceptions.MessageDeliveryFailure
+           :raises: NotificationPayloadError
+           :raises: oslo_versionedobjects.exceptions.MessageDeliveryFailure
         """
         if not self._should_notify():
             return
@@ -143,8 +143,8 @@ class NotificationPayloadBase(base.IronicObject):
 
         :param kwargs: A dict contains the source object and the keys defined
                        in the SCHEMA
-        :raises NotificationSchemaObjectError
-        :raises NotificationSchemaKeyError
+        :raises: NotificationSchemaObjectError
+        :raises: NotificationSchemaKeyError
         """
         for key, (obj, field) in self.SCHEMA.items():
             try:

ironic/objects/portgroup.py

@@ -81,7 +81,7 @@ class Portgroup(base.IronicObject, object_base.VersionedObjectDictCompat):
     def get_by_id(cls, context, portgroup_id):
         """Find a portgroup based on its integer id and return a Portgroup object.
 
-        :param portgroup id: The id of a portgroup.
+        :param portgroup_id: The id of a portgroup.
         :param context: Security context
         :returns: A :class:`Portgroup` object.
         :raises: PortgroupNotFound