NAME

WordListRole::WordList - The WordList methods

VERSION

This document describes version 0.7.11 of WordListRole::WordList (from Perl distribution WordList), released on 2021-09-26.

REQUIRED METHODS

new

each_word

next_word

reset_iterator

pick

Usage:

@words = $wl->pick([ $num=1 [ , $allow_duplicates=0 ] ]);

Examples:

($word) = $wl->pick;    # pick one item, note the list context
($word) = $wl->pick(1); # ditto
@words  = $wl->pick(3);

word_exists

all_words

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/WordList.

SOURCE

Source repository is at https://github.com/perlancar/perl-WordList.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2018, 2017, 2016 by perlancar <perlancar@cpan.org>.

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

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=WordList

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.

cpanm WordList

perl -MCPAN -e shell
install WordList