From 49c95f1d40dfd80ab7682f7b57ae0eabb559a2fc Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Fri, 28 Jul 2023 23:24:05 +0100 Subject: [PATCH] update docstrings --- .../sdk/core/openbb_core/app/provider_interface.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/openbb_sdk/sdk/core/openbb_core/app/provider_interface.py b/openbb_sdk/sdk/core/openbb_core/app/provider_interface.py index 970c0dd067a..c3b64dd8414 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/provider_interface.py +++ b/openbb_sdk/sdk/core/openbb_core/app/provider_interface.py @@ -287,7 +287,8 @@ class ProviderInterface: ) -> Dict[str, Dict[str, Union[StandardParams, ExtraParams]]]: """Generate dataclasses for params. - This creates a dictionary of dataclasses that can be used as extra params. + This creates a dictionary of dataclasses that can be inject as a FastAPI + dependency. Example: ------- @@ -326,8 +327,8 @@ class ProviderInterface: def _generate_model_providers_dc(self) -> Dict[str, ProviderChoices]: """Generate dataclasses for provider choices by model. - This creates a dictionary that maps model names to dataclasses that can be used - as provider choices. + This creates a dictionary that maps model names to dataclasses that can be + injected as a FastAPI dependency. Example: ------- @@ -355,7 +356,7 @@ class ProviderInterface: ) -> Dict[str, Dict[str, Union[StandardData, ExtraData]]]: """Generate dataclasses for data. - This creates a dictionary of dataclasses that can be used as data. + This creates a dictionary of dataclasses. Example: ------- @@ -391,7 +392,8 @@ class ProviderInterface: def _merge_data_dc( self, data: Dict[str, Dict[str, Union[StandardData, ExtraData]]] ) -> Dict[str, BaseModel]: - """Merge standard data with extra data into a single BaseModel.""" + """Merge standard data with extra data into a single BaseModel to benzinga + injected as FastAPI dependency.""" result: Dict = {} for model_name, dataclasses in data.items(): standard = dataclasses["standard"]