summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYuri Astrakhan <yuriastrakhan@gmail.com>2023-11-15 03:03:48 -0500
committerGitHub <noreply@github.com>2023-11-15 03:03:48 -0500
commita6200640b9a074feb116b7808543c8cb73c8dd30 (patch)
tree839e1ef7524cc59c484dddedac09d0f2b6ab6999
parentd1d14989005a26ff18f1c9add1c2963aafe12e8e (diff)
chore: run spell and grammar checkers
* Chore: Run an spell cheker, and gramar cheker * small revert --------- Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
-rw-r--r--.github/workflows/docs.yml2
-rw-r--r--.github/workflows/post-release.yml2
-rw-r--r--CHANGELOG.md8
-rw-r--r--docs/content/contribution/documentation.md2
-rw-r--r--docs/content/contribution/issues-and-pull-requests.md2
-rw-r--r--docs/content/contribution/packaging-and-distribution.md2
-rw-r--r--docs/content/troubleshooting.md4
-rw-r--r--docs/content/usage/widgets/process.md4
8 files changed, 13 insertions, 13 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 616739ce..3f721fd0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -11,7 +11,7 @@ on:
- ".github/workflows/docs.yml"
env:
- # Assign commit authorship to official Github Actions bot when pushing to the `gh-pages` branch:
+ # Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:
GIT_USER: "github-actions[bot]"
GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
diff --git a/.github/workflows/post-release.yml b/.github/workflows/post-release.yml
index e76fb2f7..c0e35fae 100644
--- a/.github/workflows/post-release.yml
+++ b/.github/workflows/post-release.yml
@@ -15,7 +15,7 @@ on:
required: true
env:
- # Assign commit authorship to official Github Actions bot when pushing to the `gh-pages` branch:
+ # Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:
GIT_USER: "github-actions[bot]"
GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 468540f8..80a5fe6d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -206,7 +206,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Bug Fixes
-- [#637](https://github.com/ClementTsang/bottom/pull/637): Fix process CPU calculation if /proc/stat CPU line has less values than expected
+- [#637](https://github.com/ClementTsang/bottom/pull/637): Fix process CPU calculation if /proc/stat CPU line has fewer values than expected
## Changes
@@ -422,7 +422,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [#213](https://github.com/ClementTsang/bottom/pull/213), [#214](https://github.com/ClementTsang/bottom/pull/214): Updated help descriptions, added auto-complete generation.
-- [#296](https://github.com/ClementTsang/bottom/pull/296): Changed how we do battery theming. We now only set high, medium, and low colours and we deal with the ratios.
+- [#296](https://github.com/ClementTsang/bottom/pull/296): Changed how we do battery theming. We now only set high, medium, and low colours, and we deal with the ratios.
### Bug Fixes
@@ -505,7 +505,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changes
-- [#156](https://github.com/ClementTsang/bottom/issues/156) - Removal of the `/` CPU core showing in the chart. It felt clunky to use, was not really useful, and hard to work with with large core counts.
+- [#156](https://github.com/ClementTsang/bottom/issues/156) - Removal of the `/` CPU core showing in the chart. It felt clunky to use, was not really useful, and hard to work with large core counts.
Furthermore:
@@ -651,7 +651,7 @@ is equivalent to:
- [#33](https://github.com/ClementTsang/bottom/issues/33): Fix bug with search and graphemes bigger than a byte crashing due to the cursor.
-- [#41](https://github.com/ClementTsang/bottom/issues/41): Fix bug that caused the cursor to go off screen while searching.
+- [#41](https://github.com/ClementTsang/bottom/issues/41): Fix bug that caused the cursor to go off-screen while searching.
- [#61](https://github.com/ClementTsang/bottom/issues/61): Dialog boxes set to be a constant width/height.
diff --git a/docs/content/contribution/documentation.md b/docs/content/contribution/documentation.md
index 616f3319..221115e0 100644
--- a/docs/content/contribution/documentation.md
+++ b/docs/content/contribution/documentation.md
@@ -38,7 +38,7 @@ There are a few areas where documentation changes are often needed:
For changes to the extended documentation, you'll probably want Python 3.11 (older versions should be fine though),
[MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
`mdx_truly_sane_lists`, and optionally [Mike](https://github.com/jimporter/mike) installed to provide live reloading
- and preview for your changes. They aren't needed but it'll help with validating your changes.
+ and preview for your changes. They aren't needed, but it'll help with validating your changes.
You can do so through `pip` or your system's package managers. If you use `pip`, you can use venv to cleanly install
the documentation dependencies:
diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md
index 2af973f2..86e0d58f 100644
--- a/docs/content/contribution/issues-and-pull-requests.md
+++ b/docs/content/contribution/issues-and-pull-requests.md
@@ -17,7 +17,7 @@ When filing a bug report, please use the [bug report template](https://github.co
Please use the [feature request template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.md&title=) and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful.
-Also please check whether or not an existing issue has covered your specific feature request!
+Also, please check whether an existing issue has covered your specific feature request!
## Pull requests
diff --git a/docs/content/contribution/packaging-and-distribution.md b/docs/content/contribution/packaging-and-distribution.md
index 26693c8f..6bdd6227 100644
--- a/docs/content/contribution/packaging-and-distribution.md
+++ b/docs/content/contribution/packaging-and-distribution.md
@@ -5,7 +5,7 @@ and bottom.
## Pre-built binaries
-The latest stable release can be found [here](https://github.com/ClementTsang/bottom/releases/latest), where you ca
+The latest stable release can be found [here](https://github.com/ClementTsang/bottom/releases/latest), where you can
find pre-built binaries in either a `tar.gz` or `zip` format. Binaries here also include automatically generated shell
completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging
process.
diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md
index 6c7f17f6..4bdb7cda 100644
--- a/docs/content/troubleshooting.md
+++ b/docs/content/troubleshooting.md
@@ -55,7 +55,7 @@ Let's say you're installing [Iosevka](https://github.com/be5invis/Iosevka). The
<figcaption><sub>The last entry is the new entry for Iosevka</sub></figcaption>
</figure>
-1. Then, open the Command Prompt/PowerShell, and right click on the top bar, and open "Properties":
+1. Then, open the Command Prompt/PowerShell, and right-click on the top bar, and open "Properties":
<figure>
<img src="../assets/screenshots/troubleshooting/cmd_prompt_props.webp" alt="Opening the properties menu in Command Prompt/PowerShell"/>
@@ -98,7 +98,7 @@ sudo btm
There are measures taken to try to maximize the amount of information obtained without elevated privileges. For example,
one can modify the instructions found on the [htop wiki](https://github.com/hishamhm/htop/wiki/macOS:-run-without-sudo)
-on how to run htop without sudo for bottom. However **please** understand the potential security risks before doing so!
+on how to run htop without sudo for bottom. However, **please** understand the potential security risks before doing so!
## My configuration file isn't working
diff --git a/docs/content/usage/widgets/process.md b/docs/content/usage/widgets/process.md
index a0936f61..2a11e3a7 100644
--- a/docs/content/usage/widgets/process.md
+++ b/docs/content/usage/widgets/process.md
@@ -77,13 +77,13 @@ screen will be shown to confirm whether you want to kill that process/process gr
### Tree mode
-Pressing ++t++ or ++f5++ in the table toggles tree mode in the process widget, displaying processes in regards to their parent-child process relationships.
+Pressing ++t++ or ++f5++ in the table toggles tree mode in the process widget, displaying processes in regard to their parent-child process relationships.
<figure>
<img src="../../../assets/screenshots/process/process_tree.webp" alt="A picture of tree mode in a process widget."/>
</figure>
-A process in tree mode can also be "collapsed", hiding its children and any descendants, using either the ++minus++ or ++plus++ keys, or double clicking on an entry.
+A process in tree mode can also be "collapsed", hiding its children and any descendants, using either the ++minus++ or ++plus++ keys, or double-clicking on an entry.
Lastly, note that in tree mode, processes cannot be grouped together due to the behaviour of the two modes somewhat clashing.