From 9b5f962d1906d35280b382a4ce97deec20a07220 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Mon, 14 Aug 2023 16:57:35 +0100 Subject: [PATCH 1/2] add description to OBBject --- openbb_sdk/sdk/core/openbb_core/app/model/obbject.py | 1 + 1 file changed, 1 insertion(+) diff --git a/openbb_sdk/sdk/core/openbb_core/app/model/obbject.py b/openbb_sdk/sdk/core/openbb_core/app/model/obbject.py index 6883b23ab83..e05e5a98060 100644 --- a/openbb_sdk/sdk/core/openbb_core/app/model/obbject.py +++ b/openbb_sdk/sdk/core/openbb_core/app/model/obbject.py @@ -21,6 +21,7 @@ class OpenBBError(Exception): class OBBject(GenericModel, Generic[T], Tagged): + """OpenBB custom class that holds command outputs and utility methods.""" results: Optional[T] = Field( default=None, description="Serializable results.", From a22a018df414b8f8f4ea1cc3aa57d6d9111815fa Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Mon, 14 Aug 2023 16:59:20 +0100 Subject: [PATCH 2/2] update core readme with obbject --- openbb_sdk/sdk/core/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openbb_sdk/sdk/core/README.md b/openbb_sdk/sdk/core/README.md index 3107d5b96d5..d49835cbd60 100644 --- a/openbb_sdk/sdk/core/README.md +++ b/openbb_sdk/sdk/core/README.md @@ -12,7 +12,7 @@ - [Install extension](#install-extension) - [4. Usage](#4-usage) - [4.1 Static version](#41-static-version) - - [4.1.1. Command output](#411-command-output) + - [4.1.1. OBBject](#411-obbject) - [Helpers](#helpers) - [4.1.2. Utilities](#412-utilities) - [Settings](#settings) @@ -163,9 +163,9 @@ output = obb.stocks.load( ) ``` -### 4.1.1. Command output +### 4.1.1. OBBject -Each command will always return a `OBBject`. There you will find: +Each command will always return an `OBBject`. There you will find: - `results`: the data returned by the command `None` - `provider`: the provider name (only available provider names allowed) used to get the data or `None`