/ 
Bundle-Cheat-v0.0.1
/ Bundle::Cheat::Test

NAME

Bundle::Cheat::Test - Usage for Test::* modules

SYNOPSIS

$ cat Bundle/Cheat/Test.pm

DESCRIPTION

The test itself is a cheat, isn't it? I mean you program it to be unwinnable. --James Tiberius Kirk

This is a collection of "cheat sheets": highly compressed, abbreviated documentation for various modules. Each module within the bundle covers a top-level namespace or a set of otherwise closely-related modules.

For each module, a paragraph is given, generally:

Some::Module            # Short description
    qw( various exportable symbols if any );
    routine( $placeholder, @arguments );
    $context    = function( @arguments);
    $object->method();

You should be able to copy and paste this into your own code, delete what you don't need, and be on your way.

CHEATS

SEE ALSO

FUNCTIONS/METHODS

None. This module does nothing at all. You shouldn't even try to use() it; if you try, it will die().

If it didn't die() immediately, in an early BEGIN block, then it would try to use() every single module it cheats. So we don't do that.

INTERFACE

Open the module (the *.pm file itself) in your editor. Copy out whatever you like.

DIAGNOSTICS

Failed to abort. This line should never execute; please contact author.

This module contains executable code so that your editor will use its syntax highlighting feature, if any. But it would be madness to execute it all. You should never, ever see this error.

CONFIGURATION AND ENVIRONMENT

Bundle::Cheat::Test requires no configuration files or environment variables.

DEPENDENCIES

No dependencies.

INCOMPATIBILITIES

None.

BUGS AND LIMITATIONS

No cheat sheet will teach you anything. It's only a reminder. You must consult each module's own full documentation at least before using it. I hope.

This module does not contain magic to squirt code into your module. Copy and paste.

THANKS

  • To about 8500 authors who have uploaded about 85,000 modules to the CPAN.

AUTHOR

Xiong Changnian <xiong@cpan.org>

LICENSE

Copyright (C) 2010 Xiong Changnian <xiong@cpan.org>

This library and its contents are released under Artistic License 2.0:

http://www.opensource.org/licenses/artistic-license-2.0.php