Skip to content

Commit

Permalink
Fix typos in the documentation, README.md and code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ccoVeille committed Apr 21, 2024
1 parent d641847 commit 2838e2e
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@

- **pretty**: `pls` output is cleaner, friendlier and more colorful.
- **powerful**: `pls` provides more features than the competition.
- **performant**: `pls` is speedy and performant (written in Rust).
- **performing**: `pls` is speedy and performing (written in Rust).
- **practical**: `pls` has sensible defaults and an effortless interface.
- **petite**: `pls` is a small, single-file, binary executable.
- **pliable**: `pls` can be extensively tweaked by power users and pros.
- **personable**: `pls` prioritises consumption by humans over scripts.
- **personable**: `pls` prioritizes consumption by humans over scripts.

Pick whichever adjective helps you remember the command name.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/about/comparison.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description:
---

<Pls /> has the distinction of being an `ls(1)` replacement specifically
targeted a a pro audience. This leads to different motivations, different
targeted a pro audience. This leads to different motivations, different
decisions, different choices and different defaults. This also gives us the
advantage of being able to provide features that are powerful but complex.

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/about/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ deep customisation.
**Why Rust and not _&lt;language&gt;_?**

Rust is a good choice for CLI utilities because it enables them to be very
performant. The pros don't want to see lag in a core part of your workflow.
performing. The pros don't want to see lag in a core part of your workflow.

Before I learned Rust, <Pls /> was written in Python (which was another reason
Before, I learned Rust, <Pls /> was written in Python (which was another reason
it's called <Pls />). It seemed like a good fit at the time because it was
decently fast and easy to develop and distribute, but at a certain point Python
started becoming a speed bottleneck. The point being, give me a good reason, and
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/about/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ your directories, and searching for specific files, effortless.
<Pls /> providers more features than the competition. It uses a cascading
config system with specs.
</Card>
<Card title="Performant" icon="rocket">
<Pls /> is speedy and performant (written in Rust). It continues to be fast
<Card title="Performing" icon="rocket">
<Pls /> is speedy and performing (written in Rust). It continues to be fast
even with all features enabled.
</Card>
<Card title="Practical" icon="approve-check">
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/features/detail_view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ pls --det=all # or -d=all

## Configuration

Each of the detail fields is deeply customisable. Read on to know more the
Each of the detail fields is deeply customizable. Read on to know more the
customisation options supported by each field.

### Fields
Expand Down
4 changes: 2 additions & 2 deletions src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
//! `pls` supports customisation in two ways, through CLI arguments that change
//! the output per session and through `.pls.yml` YAML files that can go deeper
//! to tweak each individual string, change icons and add new node specs.
//! Together they make `pls` the most customisable file lister.
//! Together they make `pls` the most customizable file lister.
//!
//! For example, the the CLI arg `--det` controls what metadata columns must be
//! For example, the CLI arg `--det` controls what metadata columns must be
//! shown in a given run, whereas the `.pls.yml` file can be used to change the
//! individual name for these columns.
//!
Expand Down

0 comments on commit 2838e2e

Please sign in to comment.