Shlomi Fish avatar Shlomi Fish committed 8039fbf

Add some spec/docs to ModuleList.

Comments (0)

Files changed (1)

Module-Format/Module-Format/lib/Module/Format/ModuleList.pm

 
 =head1 NAME
 
-Module::Format::ModuleList - an ordered list of Module::Format::Modules.
+Module::Format::ModuleList - an ordered list of L<Module::Format::Module>.
 
 =head1 VERSION
 
 
 =head1 SYNOPSIS
 
-TODO : FILL IN.
+    use Module::Format::ModuleList;
+
+    my $list = Module::Format::ModuleList->new(
+        {
+            modules =>
+            [
+                Module::Format::Module->from_guess('XML::RSS'),
+                Module::Format::Module->from_guess('Data-Dumper'),
+            ],
+        }
+    );
+
+    foreach my $name (@{$list->format_as('rpm_colon')})
+    {
+        print "$name\n";    
+    }
+
+    my $list = Module::Format::ModuleList->sane_from_guesses(
+        {
+            values =>
+            [qw/
+                Algorithm::Permutations
+                rpm(Foo::Bar::Baz)
+                perl-HTML-TreeBuilder-LibXML
+            /],
+        },
+    )
+
+=cut
+
+use Module::Format::Module;
 
 =head1 AUTHOR
 
-Shlomi Fish, C<< <shlomif at cpan.org> >>
+Shlomi Fish, L<http://www.shlomifish.org/>
 
 =head1 BUGS
 
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.