From f8b0594363ca758e6ec00e3d4ab8aebe86e6ec56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jagoda=20Estera=20=C5=9Al=C4=85zak?= <128227338+j-g00da@users.noreply.github.com> Date: Tue, 7 Oct 2025 09:12:26 +0200 Subject: [PATCH] docs: fix typos (#2129) This fixes the pipeline after bumping typos. --- CHANGELOG.md | 6 +++--- cliff.toml | 5 ++++- ratatui-core/src/style/color.rs | 4 ++-- ratatui-core/src/symbols/merge.rs | 4 ++-- 4 files changed, 11 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 485aafcb..aaa81ab7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5955,7 +5955,7 @@ Adds conversions for various Color and Modifier combinations - removed box borders - show the difference between ratio / percentage and unicode / no unicode better - better application approach (consistent with newer examples) - - various changes for 0.26 featuers + - various changes for 0.26 features - impl `Widget` for `&App` - use color_eyre @@ -6910,7 +6910,7 @@ Also, we created various tutorials and walkthroughs in [Ratatui Book](https://gi color attribute - it is enabled by default, but can be disabled by passing `--no-default-features` to cargo. - We could specically check for Windows 7 and disable the feature flag + We could specially check for Windows 7 and disable the feature flag automatically, but I think it's better for this check to be done by the crossterm crate, since it's the one that actually knows about the underlying terminal. @@ -8035,7 +8035,7 @@ Here is the list of contributors who have contributed to `ratatui` for the first ### Bug Fixes - _(clippy)_ Unused_mut lint for layout ([#285](https://github.com/ratatui/ratatui/issues/285)) -- _(examples)_ Correct progress label in gague example ([#263](https://github.com/ratatui/ratatui/issues/263)) +- _(examples)_ Correct progress label in gauge example ([#263](https://github.com/ratatui/ratatui/issues/263)) - _(layout)_ Cap Constraint::apply to 100% length ([#264](https://github.com/ratatui/ratatui/issues/264)) - _(lint)_ Suspicious_double_ref_op is new in 1.71 ([#311](https://github.com/ratatui/ratatui/issues/311)) - _(prelude)_ Remove widgets module from prelude ([#317](https://github.com/ratatui/ratatui/issues/317)) diff --git a/cliff.toml b/cliff.toml index 5c94308f..58cd9305 100644 --- a/cliff.toml +++ b/cliff.toml @@ -104,10 +104,13 @@ commit_preprocessors = [ { pattern = '(Clarify README.md)', replace = "docs(readme): ${1}" }, { pattern = '(Update README.md)', replace = "docs(readme): ${1}" }, { pattern = '(fix typos|Fix typos)', replace = "fix: ${1}" }, - # a small typo that squeaked through and which would otherwise trigger the typos linter. + # Typos that squeaked through and which would otherwise trigger the typos linter. # Regex obsfucation is to avoid triggering the linter in this file until there's a per file config # See https://github.com/crate-ci/typos/issues/724 { pattern = '\<[d]eatil\>', replace = "detail" }, + { pattern = '\<[f]eatuers\>', replace = "features" }, + { pattern = '\<[s]pecically\>', replace = "specially" }, + { pattern = '\<[g]ague\>', replace = "gauge" }, ] # regex for parsing and grouping commits commit_parsers = [ diff --git a/ratatui-core/src/style/color.rs b/ratatui-core/src/style/color.rs index 17f32c55..47fa9264 100644 --- a/ratatui-core/src/style/color.rs +++ b/ratatui-core/src/style/color.rs @@ -655,8 +655,8 @@ mod tests { "abcdef0", // 7 chars is not a color " bcdefa", // doesn't start with a '#' "#abcdef00", // too many chars - "#1🦀2", // len 7 but on char boundaries shouldnt panic - "resett", // typo + "#1🦀2", // len 7 but on char boundaries shouldn't panic + "resets", // typo "lightblackk", // typo ]; diff --git a/ratatui-core/src/symbols/merge.rs b/ratatui-core/src/symbols/merge.rs index ac12d8dd..cff1758b 100644 --- a/ratatui-core/src/symbols/merge.rs +++ b/ratatui-core/src/symbols/merge.rs @@ -99,7 +99,7 @@ pub enum MergeStrategy { /// /// The following diagram illustrates how this would apply to several overlapping blocks where /// the thick bordered blocks are rendered last, merging the previous symbols into a single - /// composite character. All combindations of the plain and thick segments exist, so these + /// composite character. All combinations of the plain and thick segments exist, so these /// symbols can be merged into a single character: /// /// ```text @@ -264,7 +264,7 @@ pub enum MergeStrategy { /// assert_eq!(strategy.merge("┃", "═"), "╬"); /// assert_eq!(strategy.merge("═", "┃"), "╋"); /// - /// // combindations of double with plain that don't exist are merged based on the second symbol + /// // combinations of double with plain that don't exist are merged based on the second symbol /// assert_eq!(strategy.merge("┐", "╔"), "╦"); /// assert_eq!(strategy.merge("╔", "┐"), "┬"); /// ```