Fix typos in **/*.md

haskell · Nov 29, 2024 · b921a98 · b921a98
1 parent a7c398d
commit b921a98
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 2 deletions.
diff --git a/Cabal/ChangeLog.md b/Cabal/ChangeLog.md
@@ -773,7 +773,7 @@
   * Many checks added for common mistakes
   * New `--package-db=` option for specific package databases
   * Many internal changes to support cabal-install
-  * Stricter parsing for version strings, eg dissalows "1.05"
+  * Stricter parsing for version strings, eg disallows "1.05"
   * Improved user guide introduction
   * Programatica support removed
   * New options `--program-prefix/suffix` allows eg versioned programs

diff --git a/Makefile b/Makefile
@@ -52,10 +52,12 @@ fix-whitespace: ## Run fix-whitespace in fix mode
 .PHONY: typos
 typos: ## Find typos in users guide
 	typos **/*.rst
+	typos **/*.md
 
 .PHONY: fix-typos
 fix-typos: ## Fix typos in users guide
 	typos --write-changes **/*.rst
+	typos --write-changes **/*.md
 
 .PHONY: typos-install
 typos-install: ## Install typos-cli for typos target using cargo

diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,2 @@
+[default]
+extend-ignore-re = ["(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"]
diff --git a/doc/README.md b/doc/README.md
@@ -50,7 +50,8 @@ To check for typos, run `make typos` and to fix them, run `make fix-typos`. Fixi
 > SOURCE: [typos/Getting Started](https://github.com/crate-ci/typos#getting-started)
 
 ```
-make typos
+# spellchecker:off
+$ make typos
 typos **/*.rst
 error: `managable` should be `manageable`, `manageably`
   --> doc/getting-started.rst:75:6
@@ -59,6 +60,7 @@ error: `managable` should be `manageable`, `manageably`
    |      ^^^^^^^^^
    |
 make: *** [Makefile: typos] Error 2
+# spellchecker:on
 ```
 
 ### Gitpod workflow
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[default]
		extend-ignore-re = ["(?s)(#\|//)\\sspellchecker:off.?\\n\\s(#\|//)\\sspellchecker:on"]