Skip to content

Commit 117ff1d

Browse files
committed
Made explicit that aspell is a requirement to run spell checks on docs.
1 parent ba96379 commit 117ff1d

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/internals/contributing/writing-documentation.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,9 @@ Spelling check
178178
~~~~~~~~~~~~~~
179179

180180
Before you commit your docs, it's a good idea to run the spelling checker.
181-
You'll need to install :pypi:`sphinxcontrib-spelling` first. Then from the
182-
``docs`` directory, run:
181+
You'll need to install :pypi:`sphinxcontrib-spelling` first. The spell checker
182+
also requires a system-level spell checking backend such as `Aspell
183+
<http://aspell.net/>`__. Then from the ``docs`` directory, run:
183184

184185
.. console::
185186

0 commit comments

Comments
 (0)