Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs: minor fixes to misc

Elijah Potter2208d5284723
diff --git a/harper-core/src/linting/mod.rs b/harper-core/src/linting/mod.rs
index 1f329af3b..c21e3330c 100644
--- a/harper-core/src/linting/mod.rs
+++ b/harper-core/src/linting/mod.rs
@@ -1,3 +1,7 @@
+//! Frameworks and rules that locate errors in text.
+//!
+//! See the [`Linter`] trait and the [documentation for authoring a rule](https://writewithharper.com/docs/contributors/author-a-rule) for more information.
+
mod an_a;
mod avoid_curses;
mod boring_words;
diff --git a/harper-core/src/patterns/mod.rs b/harper-core/src/patterns/mod.rs
index 3366f8753..e71e70baf 100644
--- a/harper-core/src/patterns/mod.rs
+++ b/harper-core/src/patterns/mod.rs
@@ -1,4 +1,4 @@
-//! [`Pattern`]s are one of the more powerful constructs inside Harper, especially for beginners.
+//! [`Pattern`]s are one of the more powerful ways to query text inside Harper, especially for beginners.
//!
//! Through the [`PatternLinter`](crate::linting::PatternLinter) trait, they make it much easier to
//! build Harper [rules](crate::linting::Linter).
diff --git a/packages/web/src/routes/docs/contributors/author-a-rule/+page.md b/packages/web/src/routes/docs/contributors/author-a-rule/+page.md
index 4b15519be..8ef903207 100644
--- a/packages/web/src/routes/docs/contributors/author-a-rule/+page.md
+++ b/packages/web/src/routes/docs/contributors/author-a-rule/+page.md
@@ -150,12 +150,12 @@ If you need any help writing or debugging rules, don't be afraid to contact the
### Using Visual Studio Code
First make sure you have [the extension installed from the marketplace](https://marketplace.visualstudio.com/items?itemName=elijah-potter.harper).
-Then, can configure the path of the `harper-ls` binary the Visual Studio Code extension uses in settings.
+Then, configure the path of the `harper-ls` binary the Visual Studio Code extension uses in the settings page.
Set it to `<harper repo>/target/release/harper-ls`.
![How to change the `harper-ls` path](/images/vscode_harper_path.webp)
-Now every time you want to test a change, you'll have to recompile `harper-ls` and reload Visual Studio Code using `Developer: Reload Window`.
+Every time you want to test a change, you'll have to recompile `harper-ls` and reload Visual Studio Code with the `Developer: Reload Window` command in the command palette.
```bash
cargo build --release # Run in the monorepo to compile `harper-ls`.
@@ -163,5 +163,5 @@ cargo build --release # Run in the monorepo to compile `harper-ls`.
## Elevate Your Pull Request
-Once you're satisfied with your rule, you can go ahead and elevate your pull requests to mark it as "ready for review."
+Once you're satisfied with your rule, you can go ahead and elevate your pull request to mark it as "ready for review."
At that point, a maintainer on the Harper team take a look at it and (hopefully) merge it.