Fix a few docstring warnings

Some warnings related to docstrings and a document reference
are fixed.

Change-Id: I57a661b2fc88a9058252744af872c631fc1b87d3
This commit is contained in:
Ramamani Yeleswarapu 2017-01-31 15:13:30 -08:00
parent 4164a9eb1e
commit a1a3e2e478
4 changed files with 7 additions and 7 deletions

View File

@ -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>

View File

@ -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()

View File

@ -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:

View File

@ -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