docs: Improve function docstrings in tool classes

Author: anubhav756

packages/toolbox-core/src/toolbox_core/sync_tool.py

@@ -139,8 +139,8 @@ def add_auth_token_getters(
         auth_token_getters: Mapping[str, Callable[[], str]],
     ) -> "ToolboxSyncTool":
         """
-        Registers an auth token getter function that is used for AuthServices when tools
-        are invoked.
+        Registers auth token getter functions that are used for AuthServices
+        when tools are invoked.
 
         Args:
             auth_token_getters: A mapping of authentication service names to
@@ -149,8 +149,12 @@ def add_auth_token_getters(
         Returns:
             A new ToolboxSyncTool instance with the specified authentication token
             getters registered.
-        """
 
+        Raises:
+            ValueError: If an auth source has already been registered either to
+            the tool or to the corresponding client.
+
+        """
         new_async_tool = self.__async_tool.add_auth_token_getters(auth_token_getters)
         return ToolboxSyncTool(new_async_tool, self.__loop, self.__thread)
 
@@ -183,13 +187,17 @@ def bind_params(
         Binds parameters to values or callables that produce values.
 
         Args:
-            bound_params: A mapping of parameter names to values or callables that
-                produce values.
+            bound_params: A mapping of parameter names to values or callables
+                that produce values.
 
         Returns:
             A new ToolboxSyncTool instance with the specified parameters bound.
-        """
 
+        Raises:
+            ValueError: If a parameter has already been bound or is not present
+            in the tool schema.
+
+        """
         new_async_tool = self.__async_tool.bind_params(bound_params)
         return ToolboxSyncTool(new_async_tool, self.__loop, self.__thread)
 
@@ -208,5 +216,9 @@ def bind_param(
 
         Returns:
             A new ToolboxSyncTool instance with the specified parameter bound.
+
+        Raises:
+            ValueError: If the parameter has already been bound or is not
+            present in the tool schema.
         """
         return self.bind_params({param_name: param_value})

packages/toolbox-core/src/toolbox_core/tool.py

@@ -281,8 +281,8 @@ def add_auth_token_getters(
         auth_token_getters: Mapping[str, Callable[[], str]],
     ) -> "ToolboxTool":
         """
-        Registers an auth token getter function that is used for AuthServices when tools
-        are invoked.
+        Registers auth token getter functions that are used for AuthServices
+        when tools are invoked.
 
         Args:
             auth_token_getters: A mapping of authentication service names to
@@ -293,8 +293,8 @@ def add_auth_token_getters(
             getters registered.
 
         Raises
-            ValueError: If the auth source has already been registered either
-            to the tool or to the corresponding client.
+            ValueError: If an auth source has already been registered either to
+            the tool or to the corresponding client.
         """
 
         # throw an error if the authentication source is already registered
@@ -380,6 +380,10 @@ def bind_params(
 
         Returns:
             A new ToolboxTool instance with the specified parameters bound.
+
+        Raises:
+            ValueError: If a parameter has already been bound or is not
+            present in the tool schema.
         """
         param_names = set(p.name for p in self.__params)
         for name in bound_params.keys():
@@ -420,5 +424,10 @@ def bind_param(
 
         Returns:
             A new ToolboxTool instance with the specified parameters bound.
+
+        Raises:
+            ValueError: If the parameter has already been bound or is not
+            present in the tool schema.
+
         """
         return self.bind_params({param_name: param_value})