Shlomi Fish avatar Shlomi Fish committed 56a1a78

Got rid of the boilerplate.

Comments (0)

Files changed (7)

File-FindLines/module/Changes

 Revision history for File-FindLines
 
-0.01    Date/time
+0.0.1   TBD 
         First version, released on an unsuspecting world.
 

File-FindLines/module/README

 File-FindLines
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
-
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it to get an idea of the module's uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
-
+This is a module to filter a stream of records for those matching certain
+criteria (normally lines in files, similar to grep(1), but not restricted to
+it).
 
 INSTALLATION
 

File-FindLines/module/lib/File/FindLines.pm

 
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
-
     use File::FindLines;
 
     my ($re_s, $filename) = @ARGV;

File-FindLines/module/lib/File/FindLines/Result.pm

 
 =head1 NAME
 
-File::FindLines::Result - The great new File::FindLines::Result!
+File::FindLines::Result - An abstract File::FindLines Result object.
 
 =head1 VERSION
 
 
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
-
+Should not be used directly - API is subject to change.
     use File::FindLines::Result;
 
     my $foo = File::FindLines::Result->new();
-    ...
-
-=head1 EXPORT
-
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
 
 =head1 SUBROUTINES/METHODS
 
-=head2 function1
-
-=cut
-
-sub function1 {
-}
-
-=head2 function2
-
-=cut
-
-sub function2 {
-}
-
 =head1 AUTHOR
 
 Shlomi Fish, C<< <shlomif at cpan.org> >>

File-FindLines/module/lib/File/FindLines/Result/Context.pm

 
 =head1 NAME
 
-File::FindLines::Result::Context - The great new File::FindLines::Result::Context!
+File::FindLines::Result::Context - a context result object.
 
 =head1 VERSION
 
 
 our $VERSION = '0.01';
 
-
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
-
-    use File::FindLines::Result::Context;
-
-    my $foo = File::FindLines::Result::Context->new();
-    ...
-
-=head1 EXPORT
-
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
-
-=head1 SUBROUTINES/METHODS
-
-=head2 function1
-
-=cut
-
-sub function1 {
-}
-
-=head2 function2
-
-=cut
-
-sub function2 {
-}
+Should not be instantiated directly. 
 
 =head1 AUTHOR
 

File-FindLines/module/lib/File/FindLines/Result/Record.pm

 
 =head1 NAME
 
-File::FindLines::Result::Record - The great new File::FindLines::Result::Record!
+File::FindLines::Result::Record - a matching record result.
 
 =head1 VERSION
 
 
 our $VERSION = '0.01';
 
-
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
+Should not be instantiated directly.
 
     use File::FindLines::Result::Record;
 
     my $foo = File::FindLines::Result::Record->new();
     ...
 
-=head1 EXPORT
-
-A list of functions that can be exported.  You can delete this section
-if you don't export anything, such as for a purely object-oriented module.
-
 =head1 SUBROUTINES/METHODS
 
-=head2 function1
-
-=cut
-
-sub function1 {
-}
-
-=head2 function2
-
-=cut
-
-sub function2 {
-}
-
 =head1 AUTHOR
 
 Shlomi Fish, C<< <shlomif at cpan.org> >>

File-FindLines/module/t/boilerplate.t

 }
 
 TODO: {
-  local $TODO = "Need to replace the boilerplate text";
+  # local $TODO = "Need to replace the boilerplate text";
 
   not_in_file_ok(README =>
     "The README is used..."       => qr/The README is used/,
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.