From f9228a0056373bac6b5bdb165bd74ea8c4835cf0 Mon Sep 17 00:00:00 2001 From: Marius Gavrilescu Date: Tue, 1 Apr 2014 01:45:15 +0300 Subject: [PATCH] Add documentation --- lib/Text/Homestuck.pm | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/lib/Text/Homestuck.pm b/lib/Text/Homestuck.pm index ff123ca..ef508f7 100644 --- a/lib/Text/Homestuck.pm +++ b/lib/Text/Homestuck.pm @@ -104,39 +104,34 @@ filter feferi => sub { 1; __END__ -# Below is stub documentation for your module. You'd better edit it! =head1 NAME -Text::Homestuck - Perl extension for blah blah blah +Text::Homestuck - Emulate the typing quirks of Homestuck trolls =head1 SYNOPSIS use Text::Homestuck; - blah blah blah + say feferi 'HELLO WORLD!'; # )(-ELLO WORLD! + my @array = ('Move along.', 'Nothing to see here'); + aradia for @array; + say "@array"; # m0ve al0ng n0thing t0 see here =head1 DESCRIPTION -Stub documentation for Text::Homestuck, created by h2xs. It looks like the -author of the extension was negligent enough to leave the stub -unedited. - -Blah blah blah. - -=head2 EXPORT - -None by default. - +Text::Homestuck exports several subroutines, one for each typing quirk. There are 12 such functions right now, one for each pre-scratch troll: aradia, tavros, sollux, karkat, nepeta, kanaya, terezi, vriska, equius, gamzee, eridan, feferi. +Each subroutine takes one or no arguments. If called with an argument, they apply the quirk to the argument and return the result. If called with no arguments, they apply the quirk to C<$_>, modifiying it in-place, and returning C<$_>. =head1 SEE ALSO Homestuck: L -The mspa wiki page listing the quirks: http://mspaintadventures.wikia.com/wiki/Typing_Quirk + +A table of typing quirks: L =head1 AUTHOR -Marius Gavrilescu, Emarius@E +Marius Gavrilescu C<< >> =head1 COPYRIGHT AND LICENSE -- 2.30.2