diff --git a/openbb_platform/openbb/package/economy.py b/openbb_platform/openbb/package/economy.py index cb2ac877a58..5bae7b88b07 100644 --- a/openbb_platform/openbb/package/economy.py +++ b/openbb_platform/openbb/package/economy.py @@ -115,7 +115,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.available_indice) + >>> obb.economy.available_indices() """ # noqa: E501 inputs = filter_inputs( @@ -290,7 +290,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.co) + >>> obb.economy.cot() """ # noqa: E501 inputs = filter_inputs( @@ -359,7 +359,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.cot_searc) + >>> obb.economy.cot_search() """ # noqa: E501 inputs = filter_inputs( @@ -646,7 +646,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.econca) + >>> obb.economy.econcal() """ # noqa: E501 inputs = filter_inputs( @@ -1405,7 +1405,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.index_searc) + >>> obb.economy.index_search() """ # noqa: E501 inputs = filter_inputs( @@ -1552,7 +1552,7 @@ class ROUTER_economy(Container): -------- >>> from openbb import obb - >>> obb.economy.ris) + >>> obb.economy.risk() """ # noqa: E501 inputs = filter_inputs( diff --git a/openbb_platform/openbb/package/fixedincome.py b/openbb_platform/openbb/package/fixedincome.py index 53da0d1ae3a..7905518770a 100644 --- a/openbb_platform/openbb/package/fixedincome.py +++ b/openbb_platform/openbb/package/fixedincome.py @@ -101,7 +101,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.ameribo) + >>> obb.fixedincome.ameribor() """ # noqa: E501 inputs = filter_inputs( @@ -182,7 +182,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.est) + >>> obb.fixedincome.estr() """ # noqa: E501 inputs = filter_inputs( @@ -263,7 +263,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.fe) + >>> obb.fixedincome.fed() """ # noqa: E501 inputs = filter_inputs( @@ -342,7 +342,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.ior) + >>> obb.fixedincome.iorb() """ # noqa: E501 inputs = filter_inputs( @@ -418,7 +418,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.projection) + >>> obb.fixedincome.projections() """ # noqa: E501 inputs = filter_inputs( @@ -495,7 +495,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.sof) + >>> obb.fixedincome.sofr() """ # noqa: E501 inputs = filter_inputs( @@ -575,7 +575,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.soni) + >>> obb.fixedincome.sonia() """ # noqa: E501 inputs = filter_inputs( @@ -671,7 +671,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.treasur) + >>> obb.fixedincome.treasury() """ # noqa: E501 inputs = filter_inputs( @@ -743,7 +743,7 @@ class ROUTER_fixedincome(Container): -------- >>> from openbb import obb - >>> obb.fixedincome.ycr) + >>> obb.fixedincome.ycrv() """ # noqa: E501 inputs = filter_inputs( diff --git a/openbb_platform/openbb/package/forex.py b/openbb_platform/openbb/package/forex.py index 248de62d2a4..46ebacd2e6a 100644 --- a/openbb_platform/openbb/package/forex.py +++ b/openbb_platform/openbb/package/forex.py @@ -233,7 +233,7 @@ class ROUTER_forex(Container): -------- >>> from openbb import obb - >>> obb.forex.pair) + >>> obb.forex.pairs() """ # noqa: E501 inputs = filter_inputs( diff --git a/openbb_platform/openbb/package/stocks.py b/openbb_platform/openbb/package/stocks.py index 4a73b8c233c..ef2ca2fe2d6 100644 --- a/openbb_platform/openbb/package/stocks.py +++ b/openbb_platform/openbb/package/stocks.py @@ -905,7 +905,7 @@ class ROUTER_stocks(Container): -------- >>> from openbb import obb - >>> obb.stocks.searc) + >>> obb.stocks.search() """ # noqa: E501 inputs = filter_inputs( diff --git a/openbb_platform/openbb/package/stocks_fa.py b/openbb_platform/openbb/package/stocks_fa.py index 985a258a2ea..51795839bb5 100644 --- a/openbb_platform/openbb/package/stocks_fa.py +++ b/openbb_platform/openbb/package/stocks_fa.py @@ -501,7 +501,7 @@ class ROUTER_stocks_fa(Container): -------- >>> from openbb import obb - >>> obb.stocks.fa.ca) + >>> obb.stocks.fa.cal() """ # noqa: E501 inputs = filter_inputs( @@ -1003,7 +1003,7 @@ class ROUTER_stocks_fa(Container): -------- >>> from openbb import obb - >>> obb.stocks.fa.comspli) + >>> obb.stocks.fa.comsplit() """ # noqa: E501 inputs = filter_inputs( diff --git a/openbb_platform/platform/core/openbb_core/app/static/package_builder.py b/openbb_platform/platform/core/openbb_core/app/static/package_builder.py index e6c2e1b8da7..f02a401b7fb 100644 --- a/openbb_platform/platform/core/openbb_core/app/static/package_builder.py +++ b/openbb_platform/platform/core/openbb_core/app/static/package_builder.py @@ -25,16 +25,15 @@ from typing import ( import pandas as pd from importlib_metadata import entry_points -from pydantic.fields import FieldInfo -from pydantic_core import PydanticUndefined -from starlette.routing import BaseRoute -from typing_extensions import Annotated, _AnnotatedAlias - from openbb_core.app.charting_service import ChartingService from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.provider_interface import ProviderInterface from openbb_core.app.router import CommandMap, RouterLoader from openbb_core.env import Env +from pydantic.fields import FieldInfo +from pydantic_core import PydanticUndefined +from starlette.routing import BaseRoute +from typing_extensions import Annotated, _AnnotatedAlias class Console: @@ -444,22 +443,15 @@ class DocstringGenerator: elif "forex" in route[0] and "symbol" in example_params: example_params["symbol"] = "EURUSD" - # example = "Example\n-------\n\n.. code-block:: python\n\n from openbb import obb\n\n" - # example += f" {full_command_name}(" - # for param_name, param_value in example_params.items(): - # example += f"{param_name}={param_value}, " - # example = example[:-2] + ")\n\n" - # the example should look like - # Examples - # -------- - # >>> from openbb_terminal.sdk import openbb - # >>> openbb.keys.av(key="example_key") example = "Example\n--------\n\n" example += ">>> from openbb import obb\n" example += f">>> obb.{full_command_name}(" for param_name, param_value in example_params.items(): example += f"{param_name}={param_value}, " - example = example[:-2] + ")\n\n" + if example_params: + example = example[:-2] + ")\n\n" + else: + example += ")\n\n" return example