Merge pull request #191 from elfosardo/fix-ipmi-setup-user

Add note on setup_user function in the ipmi module
redhat-cip · Apr 26, 2023 · af076d3 · af076d3
2 parents 6bbf6ae + d0c62e4
commit af076d3
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/hardware/ipmi.py b/hardware/ipmi.py
@@ -25,6 +25,8 @@
 LINE_REGEXP = re.compile(r'^([^:]+[^ ])\s*:\s*(.*[^ ])\s*$')
 
 
+# NOTE(elfosardo): this function is not used anywhere, but we leave it
+# here as it's a good example of how to implement this type of functions.
 def setup_user(channel, username, password):
     """Setup an IPMI user."""
     sys.stderr.write('Info: ipmi_setup_user: Setting user="%s", '