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

NAME

Bundle::Cheat - Copy-and-paste usage lines for lazy coders

VERSION

This document describes Bundle::Cheat version 0.0.1

SYNOPSIS

$ cat Bundle/Cheat.pm

DESCRIPTION

If a thing is worth having, it's worth cheating for. --W. C. Fields

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, although it's harmless to do so.

Other *::Cheat modules will die() if used.

INTERFACE

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

Yes, there could be many clever routines to print contents. Use your editor.

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

Bundle::Cheat 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