Skip to content

Commit 885fec0

Browse files
committed
docs: fix documentation about source/mode
1 parent 9304602 commit 885fec0

File tree

2 files changed

+2
-4
lines changed

2 files changed

+2
-4
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,7 @@ zebra
174174
<a name="golang"></a>
175175
### Are there special rules for golang source files?
176176

177-
Yes! If the file ends in `.go`, then misspell will only check spelling in comments.
178-
179-
If you want to force a file to be checked as a golang source, use `-source=go` on the command line.
177+
yes, if you want to force a file to be checked as a golang source, use `-source=go` on the command line.
180178
Conversely, you can check a golang source as if it were pure text by using `-source=text`.
181179
You might want to do this since many variable names have misspellings in them!
182180

cmd/misspell/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func main() {
113113
format = flag.String("f", "", "'csv', 'sqlite3' or custom Golang template for output")
114114
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'")
116-
mode = flag.String("source", "auto", "Source mode: auto=guess, go=golang source, text=plain or markdown-like text")
116+
mode = flag.String("source", "text", "Source mode: text (default), go")
117117
debugFlag = flag.Bool("debug", false, "Debug matching, very slow")
118118
exitError = flag.Bool("error", false, "Exit with 2 if misspelling found")
119119
showVersion = flag.Bool("v", false, "Show version and exit")

0 commit comments

Comments
 (0)