@@ -13,8 +13,27 @@ Spell check all the pod and most markdown files in the documentation directory.
13
13
Ignore case, and provide a repo-specific list of approved words,
14
14
which include technical jargon, method and class names, etc.
15
15
16
- Split the lexicons for descriptive text and code, allowing us to specify "words"
17
- that are only allowed in code (variable names, some output, etc.).
16
+ To run this test, you'll need to install aspell and the English dictionary package.
17
+
18
+ On Mac OS X, you can install aspell using macports (https://macports.org/).
19
+
20
+ = begin code
21
+ $ sudo port install aspell
22
+ $ sudo port install aspell-dict-en
23
+ = end code
24
+
25
+ On Linux, both aspell and the C < en > dictionary should be available in your
26
+ distribution's package manager and may already be installed. However, depending
27
+ on your distribution, you may need to update to aspell's C < en > dictionary to a
28
+ more recent version than the one available through your package manager. (The
29
+ 2019.10.06 version is known to work). You can download up-to-date dictionary
30
+ files directly from aspell at
31
+ L < https://ftp.gnu.org/gnu/aspell/dict/0index.html > ; the downloaded archive will
32
+ include installation instructions.
33
+
34
+ This test uses separate lexicons for descriptive text and code, allowing us to
35
+ specify "words" that are only allowed in code (variable names, some output,
36
+ etc.).
18
37
19
38
If the test fails, you can make it pass again by changing the
20
39
text (fixing the spelling issue), or adding the new word to
0 commit comments