From 92ced38bfefb3371b8ac6e49c06522334dbae9e5 Mon Sep 17 00:00:00 2001
From: Moshe Levi <moshele@mellanox.com>
Date: Tue, 6 Dec 2016 15:31:59 +0200
Subject: Fix docsting in Mellanox _detect_hardware

This is followup patch from the review
of this I4e7f7649a1bdeaa3ee99b2748037b0f37fea486c
commit.

Change-Id: I3151daec4ff4ed9c7159a9f3f7f25367586cf3ae
---
 ironic_python_agent/hardware_managers/mlnx.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'ironic_python_agent')

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:
-- 
cgit v1.2.1