summaryrefslogtreecommitdiffstats
path: root/docs
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 /docs
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>
Diffstat (limited to 'docs')
-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
5 files changed, 7 insertions, 7 deletions
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.