#NAME

Code::TidyAll::Plugin::PodSpell - Use Pod::Spell + ispell with tidyall

#VERSION

version 0.84

In configuration:

[PodSpell]
select = lib/**/*.{pm,pod}
ispell_argv = -p $ROOT/.ispell_english
suggest = 1

Uses Pod::Spell in combination with ispell to spell-check POD. Any seemingly misspelled words will be output one per line.

You can specify additional valid words by:

Adding them to your personal ispell dictionary, e.g. ~/.ispell_english
Adding them to an ispell dictionary in the project root, then including this in the configuration:
```
ispell_argv = -p $ROOT/.ispell_english
```

The dictionary file should contain one word per line.

Install ispell from your package manager or from the link above.

This plugin accepts the following configuration options:

Arguments to pass to ispell. The "-a" flag will always be passed, in order to parse the results.

The path for the ispell command. By default this is just ispell, meaning that the user's PATH will be searched for the command.

If true, show suggestions next to misspelled words. Default is false.

The source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.