Skip to content

Commit dda27aa

Browse files
committed
docs: fix typos
1 parent 5800908 commit dda27aa

File tree

1 file changed

+22
-26
lines changed

1 file changed

+22
-26
lines changed

README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Usage of misspell:
4949
-error
5050
Exit with 2 if misspelling found
5151
-f string
52-
'csv', 'sqlite3' or custom Golang template for output
52+
'csv', 'sqlite3' or custom Go template for output
5353
-i string
5454
ignore the following corrections, comma-separated
5555
-j int
@@ -89,7 +89,7 @@ To use misspell with [pre-commit](https://pre-commit.com/), add the following to
8989
* [Automatic Corrections](#correct)
9090
* [Converting UK spellings to US](#locale)
9191
* [Using pipes and stdin](#stdin)
92-
* [Golang special support](#golang)
92+
* [Go special support](#golang)
9393
* [CSV Output](#csv)
9494
* [Using SQLite3](#sqlite)
9595
* [Changing output format](#output)
@@ -192,10 +192,10 @@ zebra
192192
```
193193

194194
<a name="golang"></a>
195-
### Are there special rules for golang source files?
195+
### Are there special rules for Go source files?
196196

197-
yes, if you want to force a file to be checked as a golang source, use `-source=go` on the command line.
198-
Conversely, you can check a golang source as if it were pure text by using `-source=text`.
197+
Yes, if you want to force a file to be checked as a Go source, use `-source=go` on the command line.
198+
Conversely, you can check a Go source as if it was pure text by using `-source=text`.
199199
You might want to do this since many variable names have misspellings in them!
200200

201201
### Can I check only-comments in other programming languages?
@@ -252,7 +252,7 @@ misspell -f sqlite * | sqlite3 -init /dev/stdin -column -cmd '.width 60 15' ':me
252252
```
253253

254254
<a name="ignore"></a>
255-
### How can I ignore rules?
255+
### How can I ignore the rules?
256256

257257
Using the `-i "comma,separated,rules"` flag you can specify corrections to ignore.
258258

@@ -266,7 +266,7 @@ With debug mode on, you can see it print the corrections, but it will no longer
266266
<a name="output"></a>
267267
### How can I change the output format?
268268

269-
Using the `-f template` flag you can pass in a [golang text template](https://golang.org/pkg/text/template/) to format the output.
269+
Using the `-f template` flag you can pass in a [Go text template](https://golang.org/pkg/text/template/) to format the output.
270270

271271
One can use `printf "%q" VALUE` to safely quote a value.
272272

@@ -290,7 +290,7 @@ This corrects commonly misspelled English words in computer source code, and oth
290290
It is designed to run quickly,
291291
so it can be used as a [pre-commit hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) with minimal burden on the developer.
292292

293-
It does not work with binary formats (e.g. Word, etc.).
293+
It does not work with binary formats (e.g., Word, etc.).
294294

295295
It is not a complete spell-checking program nor a grammar checker.
296296

@@ -303,9 +303,9 @@ Some other misspelling correctors:
303303
* https://github.com/lyda/misspell-check
304304
* https://github.com/lucasdemarchi/codespell
305305

306-
They all work but had problems that prevented me from using them at scale:
306+
They all work but have problems that prevented me from using them at scale:
307307

308-
* slow, all of the above check one misspelling at a time (i.e. linear) using regexps
308+
* slow, all of the above check one misspelling at a time (i.e., linear) using regexps
309309
* not MIT/Apache2 licensed (or equivalent)
310310
* have dependencies that don't work for me (Python3, Bash, GNU sed, etc.)
311311
* don't understand American vs. British English and sometimes makes unwelcome "corrections"
@@ -318,7 +318,7 @@ That said, they might be perfect for you and many have more features than this p
318318
Misspell is easily 100x to 1000x faster than other spelling correctors.
319319
You should be able to check and correct 1000 files in under 250ms.
320320

321-
This uses the mighty power of golang's [strings.Replacer](https://golang.org/pkg/strings/#Replacer)
321+
This uses the mighty power of Go's [strings.Replacer](https://golang.org/pkg/strings/#Replacer)
322322
which is an implementation or variation of the [Aho–Corasick algorithm](https://en.wikipedia.org/wiki/Aho–Corasick_algorithm).
323323
This makes multiple substring matches *simultaneously*.
324324

@@ -337,15 +337,15 @@ Since it operates in parallel to make corrections,
337337
it can be non-obvious to determine exactly what word was corrected.
338338

339339
<a name="debug"></a>
340-
### It's making mistakes. How can I debug?
340+
### It's making mistakes. How can I debug?
341341

342342
Run using `-debug` flag on the file you want.
343343
It should then print what word it is trying to correct.
344344
Then [file a bug](https://github.com/golangci/misspell/issues) describing the problem.
345345
Thanks!
346346

347347
<a name="missing"></a>
348-
### Why is it making mistakes or missing items in golang files?
348+
### Why is it making mistakes or missing items in Go files?
349349

350350
The matching function is *case-sensitive*,
351351
so variable names that are multiple worlds either in all-uppercase or all-lowercase case sometimes can cause false positives.
@@ -360,7 +360,7 @@ You can check your code using [golint](https://github.com/golang/lint)
360360

361361
The main code is [MIT](https://github.com/golangci/misspell/blob/head/LICENSE).
362362

363-
Misspell also makes uses of the Golang standard library and contains a modified version of Golang's [strings.Replacer](https://golang.org/pkg/strings/#Replacer)
363+
Misspell also makes use of the Go standard library and contains a modified version of Go's [strings.Replacer](https://golang.org/pkg/strings/#Replacer)
364364
which is covered under a [BSD License](https://github.com/golang/go/blob/head/LICENSE).
365365
Type `misspell -legal` for more details or see [legal.go](https://github.com/golangci/misspell/blob/head/legal.go)
366366

@@ -371,9 +371,9 @@ It started with a word list from
371371
[Wikipedia](https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines).
372372
Unfortunately, this list had to be highly edited as many of the words are obsolete or based on mistakes on mechanical typewriters (I'm guessing).
373373

374-
Additional words were added based on actually mistakes seen in the wild (meaning self-generated).
374+
Additional words were added based on actual mistakes seen in the wild (meaning self-generated).
375375

376-
Variations of UK and US spellings are based on many sources including:
376+
Variations of UK and US spellings are based on many sources, including:
377377

378378
* [Comprehensive* list of American and British spelling differences (archive)](https://web.archive.org/web/20230326222449/http://tysto.com/uk-us-spelling-list.html) (with heavy editing, many are incorrect)
379379
* [American and British spelling (archive)](https://web.archive.org/web/20160820231624/http://www.oxforddictionaries.com/us/words/american-and-british-spelling-american) (excellent site but incomplete)
@@ -388,14 +388,10 @@ Corrections and help welcome.
388388

389389
Here are some ideas for enhancements:
390390

391-
*Capitalization of proper nouns* could be done (e.g. weekday and month names, country names, language names)
392-
393-
*Opinionated US spellings* US English has a number of words with alternate spellings.
391+
- Capitalization of proper nouns: could be done (e.g., weekday and month names, country names, language names)
392+
- Opinionated US spellings: US English has a number of words with alternate spellings.
394393
Think [adviser vs. advisor](http://grammarist.com/spelling/adviser-advisor/).
395-
While "advisor" is not wrong, the opinionated US locale would correct "advisor" to "adviser".
396-
397-
*Versioning* Some type of versioning is needed so reporting mistakes and errors is easier.
398-
399-
*Feedback* Mistakes would be sent to some server for aggregation and feedback review.
400-
401-
*Contractions and Apostrophes* This would optionally correct "isnt" to "isn't", etc.
394+
While "advisor" is not wrong, the opinionated US locale would correct "advisor" to "adviser".
395+
- Versioning: Some type of versioning is needed, so reporting mistakes and errors is easier.
396+
- Feedback: Mistakes would be sent to some server for aggregation and feedback review.
397+
- Contractions and Apostrophes: This would optionally correct "isnt" to "isn't", etc.

0 commit comments

Comments
 (0)