openstack/ironic
Code Issues Proposed changes

[trivial] Fix argument descriptions

Browse Source 
Fix description of arguments for nodes, port, chassis.

Change-Id: I9b0c97163ce3a84215309f34f16074140f90f8d1
This commit is contained in:
Kyrylo Romanenko 2017-07-07 18:03:36 +03:00 committed by Tuan Luong-Anh
parent b8f6d35d00
commit 11c23cb7b0
4 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1197,7 +1197,7 @@ class NodeVIFController(rest.RestController):
def post(self, vif): def post(self, vif):
"""Attach a VIF to this node """Attach a VIF to this node
:param vif_info: a dictionary of information about a VIF. :param vif: a dictionary of information about a VIF.
It must have an 'id' key, whose value is a unique identifier It must have an 'id' key, whose value is a unique identifier
for that VIF. for that VIF.
""" """

1
ironic/objects/chassis.py
View File

@ -50,6 +50,7 @@ class Chassis(base.IronicObject, object_base.VersionedObjectDictCompat):
def get(cls, context, chassis_id): def get(cls, context, chassis_id):
"""Find a chassis based on its id or uuid and return a Chassis object. """Find a chassis based on its id or uuid and return a Chassis object.
:param context: Security context
:param chassis_id: the id *or* uuid of a chassis. :param chassis_id: the id *or* uuid of a chassis.
:returns: a :class:`Chassis` object. :returns: a :class:`Chassis` object.
""" """

1
ironic/objects/node.py
View File

@ -162,6 +162,7 @@ class Node(base.IronicObject, object_base.VersionedObjectDictCompat):
def get(cls, context, node_id): def get(cls, context, node_id):
"""Find a node based on its id or uuid and return a Node object. """Find a node based on its id or uuid and return a Node object.
:param context: Security context
:param node_id: the id *or* uuid of a node. :param node_id: the id *or* uuid of a node.
:returns: a :class:`Node` object. :returns: a :class:`Node` object.
""" """

1
ironic/objects/port.py
View File

@ -66,6 +66,7 @@ class Port(base.IronicObject, object_base.VersionedObjectDictCompat):
Find a port based on its id or uuid or MAC address and return a Port Find a port based on its id or uuid or MAC address and return a Port
object. object.
:param context: Security context
:param port_id: the id *or* uuid *or* MAC address of a port. :param port_id: the id *or* uuid *or* MAC address of a port.
:returns: a :class:`Port` object. :returns: a :class:`Port` object.
:raises: InvalidIdentity :raises: InvalidIdentity