From 57a9ccc9bf15fb0063dd158f8e0b393ab8c39a36 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 21 Aug 2024 11:59:10 +0300 Subject: [PATCH 1/5] fix README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80044adc98cb..5293da4c6f7b 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Please find more about the installation process in the [OpenBB Documentation](ht ## 2. Contributing -There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️) +There are three main ways of contributing to this project. (Hopefully you have started the project by now ⭐️) ### Become a Contributor From 87f9de5f2b7cd585bcc14a1b74763025003d435e Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 21 Aug 2024 12:06:59 +0300 Subject: [PATCH 2/5] fix README.md --- cli/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cli/README.md b/cli/README.md index 94271f616f7a..6e01548f76c0 100644 --- a/cli/README.md +++ b/cli/README.md @@ -12,13 +12,13 @@ The OpenBB Platform CLI is a command line interface that wraps [OpenBB Platform](https://docs.openbb.co/platform). -It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automate data collection via OpenBB Routine Scripts. +It offers a convenient way to interact with the OpenBB Platform and its extensions, as well as automated data collection via OpenBB Routine Scripts. Find the most complete documentation, examples, and usage guides for the OpenBB Platform CLI [here](https://docs.openbb.co/cli). ## Installation -The command below provides access to the all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions). +The command below provides access to all the available OpenBB extensions behind the OpenBB Platform, find the complete list [here](https://my.openbb.co/app/platform/extensions). ```bash pip install openbb-cli From 2b5eabd9fea2eb4be98c41d9bcbad3f726fb855a Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 21 Aug 2024 12:12:18 +0300 Subject: [PATCH 3/5] fix examples.md --- openbb_platform/obbject_extensions/charting/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/obbject_extensions/charting/examples.md b/openbb_platform/obbject_extensions/charting/examples.md index 400246032a1a..59178e1af8cf 100644 --- a/openbb_platform/obbject_extensions/charting/examples.md +++ b/openbb_platform/obbject_extensions/charting/examples.md @@ -25,7 +25,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; ## Overview This page will walk through creating different charts using the `openbb-charting` extension. -The perspective for this content is from the the Python Interface, +The perspective for this content is from the Python Interface, and the examples will assume that the OpenBB Platform is installed with all optional packages. ```python From 0138dccbe4b6ae7169cca97be03fb234d18528e0 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 21 Aug 2024 12:17:31 +0300 Subject: [PATCH 4/5] fix CONTRIBUTING.md --- openbb_platform/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openbb_platform/CONTRIBUTING.md b/openbb_platform/CONTRIBUTING.md index 9af8364eba70..856c15989800 100644 --- a/openbb_platform/CONTRIBUTING.md +++ b/openbb_platform/CONTRIBUTING.md @@ -630,7 +630,7 @@ results: [{'close': 77.62, 'close_EMA_50': None}, {'close': 80.25, 'close_EMA_50 ##### Python Interface -When using the OpenBB Platform on a Python Interface, docstrings and type hints are your best friends as it provides plenty of context on how to use the commands. +When using the OpenBB Platform on a Python Interface, docstrings and type hints are your best friends as they provides plenty of context on how to use the commands. Looking at an example on the `ta` menu: ```python From 263d7c3ce2d13367557fd5c609d800fd6dbea588 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 21 Aug 2024 15:44:32 +0300 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5293da4c6f7b..80044adc98cb 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ Please find more about the installation process in the [OpenBB Documentation](ht ## 2. Contributing -There are three main ways of contributing to this project. (Hopefully you have started the project by now ⭐️) +There are three main ways of contributing to this project. (Hopefully you have starred the project by now ⭐️) ### Become a Contributor