Skip to content

Commit d73f40e

Browse files
committed
docs: typo typos
1 parent c58ee5c commit d73f40e

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Usage of misspell:
4949
-f string
5050
'csv', 'sqlite3' or custom Golang template for output
5151
-i string
52-
ignore the following corrections, comma separated
52+
ignore the following corrections, comma-separated
5353
-j int
5454
Number of workers, 0 = number of CPUs
5555
-legal
@@ -265,12 +265,12 @@ To just print probable misspellings:
265265
<a name="problem"></a>
266266
### What problem does this solve?
267267

268-
This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`, `.md`, etc).
268+
This corrects commonly misspelled English words in computer source code, and other text-based formats (`.txt`, `.md`, etc.).
269269

270270
It is designed to run quickly,
271271
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.
272272

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

275275
It is not a complete spell-checking program nor a grammar checker.
276276

@@ -287,7 +287,7 @@ They all work but had problems that prevented me from using them at scale:
287287

288288
* slow, all of the above check one misspelling at a time (i.e. linear) using regexps
289289
* not MIT/Apache2 licensed (or equivalent)
290-
* have dependencies that don't work for me (python3, bash, linux sed, etc)
290+
* have dependencies that don't work for me (python3, bash, linux sed, etc.)
291291
* don't understand American vs. British English and sometimes makes unwelcome "corrections"
292292

293293
That said, they might be perfect for you and many have more features than this project!
@@ -302,7 +302,7 @@ This uses the mighty power of golang's [strings.Replacer](https://golang.org/pkg
302302
which is an implementation or variation of the [Aho–Corasick algorithm](https://en.wikipedia.org/wiki/Aho–Corasick_algorithm).
303303
This makes multiple substring matches *simultaneously*.
304304

305-
In addition, this uses multiple CPU cores to work on multiple files.
305+
It also uses multiple CPU cores to work on multiple files concurrently.
306306

307307
<a name="issues"></a>
308308
### What problems does it have?
@@ -328,9 +328,9 @@ Thanks!
328328
### Why is it making mistakes or missing items in golang files?
329329

330330
The matching function is *case-sensitive*,
331-
so variable names that are multiple worlds either in all-upper or all-lower case sometimes can cause false positives.
331+
so variable names that are multiple worlds either in all-uppercase or all-lowercase case sometimes can cause false positives.
332332
For instance a variable named `bodyreader` could trigger a false positive since `yrea` is in the middle that could be corrected to `year`.
333-
Other problems happen if the variable name uses a English contraction that should use an apostrophe.
333+
Other problems happen if the variable name uses an English contraction that should use an apostrophe.
334334
The best way of fixing this is to use the [Effective Go naming conventions](https://golang.org/doc/effective_go.html#mixed-caps)
335335
and use [camelCase](https://en.wikipedia.org/wiki/CamelCase) for variable names.
336336
You can check your code using [golint](https://github.com/golang/lint)
@@ -341,15 +341,15 @@ You can check your code using [golint](https://github.com/golang/lint)
341341
The main code is [MIT](https://github.com/golangci/misspell/blob/master/LICENSE).
342342

343343
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)
344-
which are covered under a [BSD License](https://github.com/golang/go/blob/master/LICENSE).
344+
which is covered under a [BSD License](https://github.com/golang/go/blob/master/LICENSE).
345345
Type `misspell -legal` for more details or see [legal.go](https://github.com/golangci/misspell/blob/master/legal.go)
346346

347347
<a name="words"></a>
348348
### Where do the word lists come from?
349349

350350
It started with a word list from
351351
[Wikipedia](https://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines).
352-
Unfortunately, this list had to be highly edited as many of the words are obsolete or based from mistakes on mechanical typewriters (I'm guessing).
352+
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).
353353

354354
Additional words were added based on actually mistakes seen in the wild (meaning self-generated).
355355

@@ -366,7 +366,7 @@ Corrections and help welcome.
366366
<a name="otherideas"></a>
367367
### What are some other enhancements that could be done?
368368

369-
Here's some ideas for enhancements:
369+
Here are some ideas for enhancements:
370370

371371
*Capitalization of proper nouns* could be done (e.g. weekday and month names, country names, language names)
372372

@@ -376,6 +376,6 @@ While "advisor" is not wrong, the opinionated US locale would correct "advisor"
376376

377377
*Versioning* Some type of versioning is needed so reporting mistakes and errors is easier.
378378

379-
*Feedback* Mistakes would be sent to some server for agregation and feedback review.
379+
*Feedback* Mistakes would be sent to some server for aggregation and feedback review.
380380

381381
*Contractions and Apostrophes* This would optionally correct "isnt" to "isn't", etc.

cmd/misspell/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func main() {
111111
quietFlag = flag.Bool("q", false, "Do not emit misspelling output")
112112
outFlag = flag.String("o", "stdout", "output file or [stderr|stdout|]")
113113
format = flag.String("f", "", "'csv', 'sqlite3' or custom Golang template for output")
114-
ignores = flag.String("i", "", "ignore the following corrections, comma separated")
114+
ignores = flag.String("i", "", "ignore the following corrections, comma-separated")
115115
locale = flag.String("locale", "", "Correct spellings using locale preferences for US or UK. Default is to use a neutral variety of English. Setting locale to US will correct the British spelling of 'colour' to 'color'")
116116
mode = flag.String("source", "text", "Source mode: text (default), go (comments only)")
117117
debugFlag = flag.Bool("debug", false, "Debug matching, very slow")

0 commit comments

Comments
 (0)