From e34f9b106cab655b7541ea75340b84dcdec4008b Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Wed, 30 Oct 2024 17:48:06 -0400 Subject: [PATCH] Enhance docstring for find_provider function to include parameters, return type, and exceptions --- simplemind/utils.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/simplemind/utils.py b/simplemind/utils.py index 41ed5dc..fb70f9b 100644 --- a/simplemind/utils.py +++ b/simplemind/utils.py @@ -7,7 +7,18 @@ _PROVIDER_NAMES = [provider.NAME.lower() for provider in providers] def find_provider(provider_name: Union[str, None]): - """Find a provider by name.""" + """ + Find and instantiate a provider by name. + + Parameters: + provider_name (Union[str, None]): The name of the provider to find. + + Returns: + An instance of the provider class if found. + + Raises: + ValueError: If the provider is not found, with a suggestion for the closest match. + """ if provider_name: for provider_class in providers: if provider_class.NAME.lower() == provider_name.lower():