docs: Fix and improve docstrings

Author: anubhav756

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

@@ -139,16 +139,20 @@ 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
                 callables that return the corresponding authentication token.
 
         Returns:
-            A new ToolboxSyncTool instance with the specified authentication token
-            getters registered.
+            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)
@@ -158,7 +162,7 @@ def add_auth_token_getter(
         self, auth_source: str, get_id_token: Callable[[], str]
     ) -> "ToolboxSyncTool":
         """
-        Registers auth token getter functions that are used for AuthServices
+        Registers an auth token getter function that is used for AuthService
         when tools are invoked.
 
         Args:
@@ -167,7 +171,7 @@ def add_auth_token_getter(
 
         Returns:
             A new ToolboxSyncTool instance with the specified authentication
-            token getters registered.
+            token getter registered.
 
         Raises:
             ValueError: If the auth source has already been registered either to
@@ -188,6 +192,11 @@ def bind_params(
 
         Returns:
             A new ToolboxSyncTool instance with the specified parameters bound.
+
+        Raises:
+            ValueError: If a parameter is already bound or is not defined by the
+                tool's definition.
+
         """
 
         new_async_tool = self.__async_tool.bind_params(bound_params)
@@ -199,7 +208,7 @@ def bind_param(
         param_value: Union[Callable[[], Any], Any],
     ) -> "ToolboxSyncTool":
         """
-        Binds a parameter to the value or callables that produce it.
+        Binds a parameter to the value or callable that produce the value.
 
         Args:
             param_name: The name of the bound parameter.
@@ -208,5 +217,10 @@ def bind_param(
 
         Returns:
             A new ToolboxSyncTool instance with the specified parameter bound.
+
+        Raises:
+            ValueError: If the parameter is already bound or is not defined by
+                the tool's definition.
+
         """
         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
@@ -292,9 +292,9 @@ def add_auth_token_getters(
             A new ToolboxTool instance with the specified authentication token
             getters registered.
 
-        Raises
-            ValueError: If the auth source has already been registered either
-            to the tool or to the corresponding client.
+        Raises:
+            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
@@ -350,7 +350,7 @@ def add_auth_token_getter(
         self, auth_source: str, get_id_token: Callable[[], str]
     ) -> "ToolboxTool":
         """
-        Registers auth token getter functions that are used for AuthServices
+        Registers an auth token getter function that is used for AuthServices
         when tools are invoked.
 
         Args:
@@ -359,11 +359,11 @@ def add_auth_token_getter(
 
         Returns:
             A new ToolboxTool instance with the specified authentication token
-            getters registered.
+            getter registered.
 
-        Raises
-            ValueError: If the auth source has already been registered either
-            to the tool or to the corresponding client.
+        Raises:
+            ValueError: If the auth source has already been registered either to
+            the tool or to the corresponding client.
 
         """
         return self.add_auth_token_getters({auth_source: get_id_token})
@@ -380,6 +380,11 @@ def bind_params(
 
         Returns:
             A new ToolboxTool instance with the specified parameters bound.
+        
+        Raises:
+            ValueError: If a parameter is already bound or is not defined by the
+                tool's definition.
+
         """
         param_names = set(p.name for p in self.__params)
         for name in bound_params.keys():
@@ -411,14 +416,19 @@ def bind_param(
         param_value: Union[Callable[[], Any], Any],
     ) -> "ToolboxTool":
         """
-        Binds a parameter to the value or callables that produce it.
+        Binds a parameter to the value or callable that produce the value.
 
         Args:
             param_name: The name of the bound parameter.
             param_value: The value of the bound parameter, or a callable that
                 returns the value.
 
         Returns:
-            A new ToolboxTool instance with the specified parameters bound.
+            A new ToolboxTool instance with the specified parameter bound.
+
+        Raises:
+            ValueError: If the parameter is already bound or is not defined by
+                the tool's definition.
+
         """
         return self.bind_params({param_name: param_value})