Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
docs: fix incorrect documentation for some linters (#1151)
86xskfc46e64a0444
diff --git a/harper-core/src/linting/correct_number_suffix.rs b/harper-core/src/linting/correct_number_suffix.rsindex 146798e34..d248d21c6 100644--- a/harper-core/src/linting/correct_number_suffix.rs+++ b/harper-core/src/linting/correct_number_suffix.rs@@ -2,7 +2,7 @@ use super::{Lint, LintKind, Linter, Suggestion};use crate::{Document, OrdinalSuffix, Span, TokenKind};use crate::{Number, TokenStringExt};-/// Detect and warn that the sentence is too long.+/// Detect incorrect number suffix (e.g. "2st").#[derive(Debug, Clone, Copy, Default)]pub struct CorrectNumberSuffix;diff --git a/harper-core/src/linting/linking_verbs.rs b/harper-core/src/linting/linking_verbs.rsindex cc71dabf7..ca7e07b5f 100644--- a/harper-core/src/linting/linking_verbs.rs+++ b/harper-core/src/linting/linking_verbs.rs@@ -3,7 +3,9 @@ use crate::CharStringExt;use crate::Document;use crate::TokenStringExt;-/// Detect and warn that the sentence is too long.+/// Detect incorrect usage of linking verbs.+///+/// This ensures that linking verbs are preceded by a noun or pronoun.#[derive(Debug, Clone, Copy, Default)]pub struct LinkingVerbs;diff --git a/harper-core/src/linting/number_suffix_capitalization.rs b/harper-core/src/linting/number_suffix_capitalization.rsindex d4d4205e5..c1cc3865c 100644--- a/harper-core/src/linting/number_suffix_capitalization.rs+++ b/harper-core/src/linting/number_suffix_capitalization.rs@@ -2,7 +2,7 @@ use super::{Lint, LintKind, Linter, Suggestion};use crate::{Document, Span, TokenKind};use crate::{Number, TokenStringExt};-/// Detect and warn that the sentence is too long.+/// Detect incorrect capitalization for number suffixes (e.g. "2ND").#[derive(Debug, Clone, Copy, Default)]pub struct NumberSuffixCapitalization;