Skip to content

Commit 315612c

Browse files
committed
DOC/MINOR: improve descriptions for spell check scope options
Update the comments in `.aspell.yml` and `aspell/config_template.go` to provide a clearer, list-formatted description of the available `mode` options (`disabled`, `subject`, `commit`, `all`). This makes the configuration template easier to read and understand.
1 parent 8baf572 commit 315612c

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

.aspell.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
## Spell check scope: disabled (off), subject (first line only),
2-
## commit (full commit message), all (commit + file content)
1+
## Spell check scope (default: subject)
2+
## disabled - spell checking is off
3+
## subject - only check commit message subject (first line)
4+
## commit - check entire commit message (subject + body)
5+
## all - check commit message + all file content
36
# mode: disabled | subject | commit | all
47
mode: all
58

aspell/config_template.go

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ import (
66
)
77

88
// configTemplate is the full .aspell.yml with all options commented out and documented.
9-
const configTemplate = `## Spell check scope: disabled (off), subject (first line only),
10-
## commit (full commit message), all (commit + file content, default: subject)
9+
const configTemplate = `## Spell check scope (default: subject)
10+
## disabled - spell checking is off
11+
## subject - only check commit message subject (first line)
12+
## commit - check entire commit message (subject + body)
13+
## all - check commit message + all file content
1114
# mode: disabled | subject | commit | all
1215
1316
## Minimum word length to spell-check (words shorter than this are skipped, default: 3)

0 commit comments

Comments
 (0)