Skip to content

Commit

Permalink
Docs fix spelling issues (#6634)
Browse files Browse the repository at this point in the history
* fix README.md

* fix README.md

* fix examples.md

* fix CONTRIBUTING.md

* Update README.md
  • Loading branch information
nnsW3 authored Aug 21, 2024
1 parent 8f7555b commit 3b6ec24
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openbb_platform/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openbb_platform/obbject_extensions/charting/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3b6ec24

Please sign in to comment.