/ 
Pod-Spell-1.26
River stage two • 12 direct dependents • 80 total dependents
8 ++
/ Pod::Wordlist

NAME

Pod::Wordlist - English words that come up in Perl documentation

VERSION

version 1.26

DESCRIPTION

Pod::Wordlist is used by Pod::Spell, providing a set of words that are English jargon words that come up in Perl documentation, but which are not to be found in general English lexicons. (For example: autovivify, backreference, chroot, stringify, wantarray.)

You can also use this wordlist with your word processor by just pasting share/wordlist's content into your wordprocessor, deleting the leading Perl code so that only the wordlist remains, and then spellchecking this resulting list and adding every word in it to your private lexicon.

METHODS

learn_stopwords

    $wordlist->learn_stopwords( $text );

Modifies the stopword list based on a text block. See the rules for <adding stopwords|Pod::Spell/ADDING STOPWORDS> for details.

is_stopword

    if ( $wordlist->is_stopword( $word ) ) { ... }

Returns true if the word is found in the stopword list.

strip_stopwords

    my $out = $wordlist->strip_stopwords( $text );

Returns a string with space separated words from the original text with stopwords removed.

ATTRIBUTES

wordlist

    ref $self->wordlist eq 'HASH'; # true

This is the instance of the wordlist

no_wide_chars

If true, words with characters outside the Latin-1 range 0x00 to 0xFF will be stripped like stopwords.

WORDLIST

Note that the scope of this file is only English, specifically American English. (But you may find in useful to incorporate into your own lexicons, even if they are for other dialects/languages.)

remove any q{'s} before adding to the list.

The list should be sorted and uniqued. The following will work (with GNU Coreutils ).

    sort share/wordlist -u > /tmp/sorted && mv /tmp/sorted share/wordlist

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-Spell or by email to bug-Pod-Spell@rt.cpan.org.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS

  • Sean M. Burke <sburke@cpan.org>

  • Caleb Cushing <xenoterracide@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Olivier Mengué.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)