Permalink
Browse files

various POD tweaks

  • Loading branch information...
1 parent 206491e commit 565331cc3a18a057a0bbbaf036164f207d5dd771 Apocalypse committed Jan 15, 2012
Showing with 18 additions and 10 deletions.
  1. +4 −6 lib/CPAN/WWW/Top100/Retrieve.pm
  2. +12 −2 lib/CPAN/WWW/Top100/Retrieve/Dist.pm
  3. +2 −2 lib/CPAN/WWW/Top100/Retrieve/Utils.pm
@@ -203,25 +203,23 @@ The attributes are:
A boolean value specifying debug warnings or not.
+The default is: false
+
=head3 ua
( not required )
The LWP::UserAgent object to use in place of the default one.
-The default is:
-
- LWP::UserAgent->new;
+The default is: LWP::UserAgent->new;
=head3 uri
( not required )
The uri of Top100 data we should use to retrieve data in place of the default one.
-The default is:
-
- CPAN::WWW::Top100::Retrieve::Utils::default_top100_uri()
+The default is: CPAN::WWW::Top100::Retrieve::Utils::default_top100_uri()
=head2 Methods
@@ -53,7 +53,7 @@ __PACKAGE__->meta->make_immutable;
=pod
-=for stopwords todo dbid dist
+=for stopwords dbid dist
=head1 SYNOPSIS
@@ -80,28 +80,38 @@ Those attributes hold information about the distribution.
The type of Top100 this dist is listed on.
-example: heavy
+Example: heavy
=head3 dbid
The dbid of Top100 this dist is listed on.
+Example: 1
+
=head3 rank
The rank of this dist on the Top100 list.
+Example: 81
+
=head3 author
The author of this dist.
+Example: LBROCARD
+
=head3 dist
The distribution name.
+Example: Tapper-MCP
+
=head3 score
The score of the distribution on the Top100 list.
+Example: 153
+
If the type is: heavy
The score is the number of downstream dependencies
@@ -13,7 +13,7 @@ sub default_top100_uri {
return 'http://ali.as/top100/data.html';
}
-# TODO hardcoded from CPAN::WWW::Top100::Generator v0.08
+# hardcoded from CPAN::WWW::Top100::Generator v0.08
my %dbid_type = (
1 => 'heavy',
2 => 'volatile',
@@ -58,7 +58,7 @@ sub dbids {
=pod
-=for stopwords todo Top100 IDs dbid dbids uri
+=for stopwords Top100 IDs dbid dbids uri
=head1 SYNOPSIS

0 comments on commit 565331c

Please sign in to comment.