Skip to content

Commit

Permalink
[DOC] Grammar corrections to developer installation and installation (#…
Browse files Browse the repository at this point in the history
…1918)

* Update dev_installation.md

Made error solution into a note

* Update installation.md

Changed a period to a comma, made the letter at the start of the next word lowercase, and corrected the spelling of guarantee

* Update installation.md

Copied and pasted the exact suggestion from the discussion after finding a small difference after making the previous corrections

* Automatic `pre-commit` fixes

* Update installation.md

Updated spacing inside of a note

---------

Co-authored-by: phershbe <phershbe@users.noreply.github.com>
  • Loading branch information
phershbe and phershbe authored Aug 7, 2024
1 parent 3a6e93b commit fd9fd68
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/developer_guide/dev_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ and type:
pip install --editable .[dev]
```

**If this results in a "no matches found" error**, it may be due to how your shell
handles special characters. Try surrounding the dependency portion with quotes:
```{note}
If this results in a "no matches found" error, it may be due to how your shell
handles special characters. Try surrounding the dependency portion with quotes i.e.
```{code-block} powershell
pip install --editable ."[dev]"
pip install --editable ."[dev]"
```

Alternatively, the `.` may be replaced with a full or relative path to the root
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ develop the `aeon` codebase and for most other contributions to the project. [Ou
developer installation guide is available here](../developer_guide/dev_installation).

```{note}
While we try to keep output similar between OS and Python version. We cannot
guarentee the estimators will output the same results for macOS ARM processors.
While we try to keep output similar between OS and Python version, we cannot
guarantee estimators will output the same results for macOS ARM processors.
```

## Optional Dependencies
Expand Down

0 comments on commit fd9fd68

Please sign in to comment.