jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove export_to_file flag for redundancy

Browse Source
This commit is contained in:
Joseph Walker
2023-02-10 11:51:38 -05:00
parent 06b919630e
commit f247b6da34
2 changed files with 8 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
openbb_terminal/stocks/stocks_helper.py
View File

@@ -106,7 +106,6 @@ def search(
limit: int = 0,
export: str = "",
sheet_name: Optional[str] = "",
export_to_file: bool = True,
) -> Optional[pd.DataFrame]:
"""Search selected query for tickers.
@@ -128,8 +127,6 @@ def search(
The limit of companies shown.
export : str
Export data
export_to_file : bool
Whether results should be exported to file or not.
Returns
-------
@@ -230,14 +227,13 @@ def search(
headers=["Name", "Country", "Sector", "Industry", "Exchange"],
title=title,
)
if export_to_file:
export_data(
export,
os.path.dirname(os.path.abspath(__file__)),
"search",
df,
sheet_name,
)
export_data(
export,
os.path.dirname(os.path.abspath(__file__)),
"search",
df,
sheet_name,
)
return df

3
website/content/sdk/reference/stocks/search.md vendored
View File

@@ -10,7 +10,7 @@ Search selected query for tickers.
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L98)]
```python
openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0, export: str = "", sheet_name: Optional[str] = "", export_to_file: bool = True)
openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0, export: str = "", sheet_name: Optional[str] = "")
```
---
@@ -27,7 +27,6 @@ openbb.stocks.search(query: str = "", country: str = "", sector: str = "", indus
| limit | int | The limit of companies shown. | 0 | True |
| export | str | Export data | | True |
| sheet_name | str | Sheet Name | | True |
| export_to_file | bool | Whether results should be exported to file or not. | | True |
---