Improving Docstring for UnifyClient in single_sign_on_tool.py #2
Description
Description:
The docstring for the UnifyClient class in unify_llm_tool/tools/single_sign_on_tool.py could be more informative and complete. Currently, it lacks detailed descriptions for the configs, secrets, and kwargs parameters.
My suggested Improvement:
Provide a more comprehensive docstring that clearly explains the purpose of each parameter and how they are used. Here's an example of an improved docstring:
class UnifyClient(Unify):
"""
Unify client with extended initialization parameters.
:param configs: Configuration key-value pairs. This can include settings like
default model or provider.
:type configs: Dict[str, str], optional
:param secrets: Secret key-value pairs, such as the API key for authentication.
:type secrets: Dict[str, str], optional
:param kwargs: Additional keyword arguments that are passed to the base Unify class.
These may include `api_key`, `endpoint`, `model`, and `provider`.
Values in `kwargs` will take precedence over those in `configs` and `secrets`.
"""
def __init__(self, configs: dict = None, secrets: dict = None, **kwargs: dict):
# ... existing code ...This improved UnifyClient docstring to be more informative by including details about its purpose, parameters, and their priority. This can enhance readability and make the code easier to understand and maintain.