Added documentation to players.helpers functions.

Author: satoon101

addons/source-python/packages/source-python/players/helpers.py

@@ -89,7 +89,11 @@
 # >> OTHER HELPER FUNCTIONS
 # =============================================================================
 def index_from_steamid(steamid):
-    """Return an index from the given SteamID."""
+    """Return an index from the given SteamID.
+
+    :param str steamid: The SteamID to get the index of.
+    :rtype: int
+    """
     # Loop through all players on the server
     for edict in PlayerGenerator():
 
@@ -107,7 +111,11 @@ def index_from_steamid(steamid):
 
 
 def index_from_uniqueid(uniqueid):
-    """Return an index from the given UniqueID."""
+    """Return an index from the given UniqueID.
+
+    :param str uniqueid: The UniqueID to get the index of.
+    :rtype: int
+    """
     # Loop through all players on the server
     for edict in PlayerGenerator():
 
@@ -125,7 +133,11 @@ def index_from_uniqueid(uniqueid):
 
 
 def index_from_name(name):
-    """Return an index from the given player name."""
+    """Return an index from the given player name.
+
+    :param str name: The player name to get the index of.
+    :rtype: int
+    """
     # Loop through all players on the server
     for edict in PlayerGenerator():
 
@@ -143,7 +155,13 @@ def index_from_name(name):
 
 
 def uniqueid_from_playerinfo(playerinfo):
-    """Return the UniqueID for the given player."""
+    """Return the UniqueID for the given player.
+
+    :param PlayerInfo playerinfo: The PlayerInfo
+        instance to get the UniqueID from.
+    :return: The UniqueID of the player. E.g. 'BOT_STAN' or 'STEAM_0:0:12345'
+    :rtype: str
+    """
     # Is the player a Bot?
     if playerinfo.is_fake_client():
 
@@ -167,12 +185,25 @@ def uniqueid_from_playerinfo(playerinfo):
 
 
 def uniqueid_from_index(index):
-    """Return the UniqueID for the given player index."""
+    """Return the UniqueID for the given player index.
+
+    :param int index: The player index to get the UniqueID from.
+    :return: The UniqueID of the player. E.g. 'BOT_STAN' or 'STEAM_0:0:12345'
+    :rtype: str
+    """
     return uniqueid_from_playerinfo(playerinfo_from_index(index))
 
 
 def address_from_playerinfo(playerinfo):
-    """Return the IP address for the given player."""
+    """Return the IP address for the given player.
+
+    If the player is a bot, an empty string will be returned.
+
+    :param PlayerInfo playerinfo: The PlayerInfo
+        instance to get the UniqueID from.
+    :return: The IP address. E.g. '127.0.0.1:27015'
+    :rtype: str
+    """
     # Is the player a bot?
     if playerinfo.is_fake_client():