This commit is contained in:
Igor Radovanovic
2023-10-18 12:44:45 +02:00
parent 97073051f9
commit 6ab593e42b
6 changed files with 27 additions and 35 deletions

View File

@@ -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(

View File

@@ -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(

View File

@@ -233,7 +233,7 @@ class ROUTER_forex(Container):
--------
>>> from openbb import obb
>>> obb.forex.pair)
>>> obb.forex.pairs()
""" # noqa: E501
inputs = filter_inputs(

View File

@@ -905,7 +905,7 @@ class ROUTER_stocks(Container):
--------
>>> from openbb import obb
>>> obb.stocks.searc)
>>> obb.stocks.search()
""" # noqa: E501
inputs = filter_inputs(

View File

@@ -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(

View File

@@ -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