Add code comment

ansible-collections · May 5, 2021 · aab56b9 · aab56b9
1 parent 9b4e2c1
commit aab56b9
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/plugins/module_utils/client/discovery.py b/plugins/module_utils/client/discovery.py
@@ -43,6 +43,10 @@ def __get_default_cache_id(self):
         return cache_id.encode('utf-8')
 
     def __get_user(self):
+        # This is intended to provide a portable method for getting a username.
+        # It could, and maybe should, be replaced by getpass.getuser() but, due
+        # to a lack of portability testing the original code is being left in
+        # place.
         if hasattr(os, 'getlogin'):
             try:
                 user = os.getlogin()