summaryrefslogtreecommitdiff
path: root/ironic_python_agent/hardware_managers
diff options
context:
space:
mode:
authorMoshe Levi <moshele@mellanox.com>2016-12-06 15:31:59 +0200
committerMoshe Levi <moshele@mellanox.com>2016-12-06 15:32:07 +0200
commit92ced38bfefb3371b8ac6e49c06522334dbae9e5 (patch)
tree2c43556806322083ae973f8883f707d234a674c0 /ironic_python_agent/hardware_managers
parent73825b28b89a85435072cd8f3f8140bc86c3b763 (diff)
downloadironic-python-agent-92ced38bfefb3371b8ac6e49c06522334dbae9e5.tar.gz
Fix docsting in Mellanox _detect_hardware
This is followup patch from the review of this I4e7f7649a1bdeaa3ee99b2748037b0f37fea486c commit. Change-Id: I3151daec4ff4ed9c7159a9f3f7f25367586cf3ae
Diffstat (limited to 'ironic_python_agent/hardware_managers')
-rw-r--r--ironic_python_agent/hardware_managers/mlnx.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/ironic_python_agent/hardware_managers/mlnx.py b/ironic_python_agent/hardware_managers/mlnx.py
index 63ef5b32..c8f4dd78 100644
--- a/ironic_python_agent/hardware_managers/mlnx.py
+++ b/ironic_python_agent/hardware_managers/mlnx.py
@@ -56,7 +56,8 @@ def _generate_client_id(address):
def _detect_hardware():
"""method for detection of Mellanox NICs
- :return True/False
+ :returns: Boolean value. True if the machine contain one
+ or more Mellanox NIC(s), False otherwise.
"""
iface_names = os.listdir('/sys/class/net')
for ifname in iface_names: