openstack/ironic
Code Issues Proposed changes

Merge "Fix a few docstring warnings"

Browse Source
This commit is contained in:
Jenkins 2017-02-01 19:24:45 +00:00 committed by Gerrit Code Review
commit 646a1f76a9
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/index.rst
View File

@ -109,7 +109,7 @@ the developer community about any implementation using this functionality.
:maxdepth: 1 :maxdepth: 1
Driver Overview <dev/drivers> 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> Writing "vendor_passthru" methods <dev/vendor-passthru>
Third party continuous integration testing <dev/third-party-ci> Third party continuous integration testing <dev/third-party-ci>

2
ironic/api/controllers/v1/port.py
View File

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

8
ironic/objects/notification.py
View File

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

2
ironic/objects/portgroup.py
View File

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