Skip to content

Commit

Permalink
various POD tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Apocalypse authored and Apocalypse committed Jan 15, 2012
1 parent 206491e commit 565331c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
10 changes: 4 additions & 6 deletions lib/CPAN/WWW/Top100/Retrieve.pm
Expand Up @@ -203,25 +203,23 @@ The attributes are:
A boolean value specifying debug warnings or not. A boolean value specifying debug warnings or not.
The default is: false
=head3 ua =head3 ua
( not required ) ( not required )
The LWP::UserAgent object to use in place of the default one. The LWP::UserAgent object to use in place of the default one.
The default is: The default is: LWP::UserAgent->new;
LWP::UserAgent->new;
=head3 uri =head3 uri
( not required ) ( not required )
The uri of Top100 data we should use to retrieve data in place of the default one. The uri of Top100 data we should use to retrieve data in place of the default one.
The default is: The default is: CPAN::WWW::Top100::Retrieve::Utils::default_top100_uri()
CPAN::WWW::Top100::Retrieve::Utils::default_top100_uri()
=head2 Methods =head2 Methods
Expand Down
14 changes: 12 additions & 2 deletions lib/CPAN/WWW/Top100/Retrieve/Dist.pm
Expand Up @@ -53,7 +53,7 @@ __PACKAGE__->meta->make_immutable;


=pod =pod
=for stopwords todo dbid dist =for stopwords dbid dist
=head1 SYNOPSIS =head1 SYNOPSIS
Expand All @@ -80,28 +80,38 @@ Those attributes hold information about the distribution.
The type of Top100 this dist is listed on. The type of Top100 this dist is listed on.
example: heavy Example: heavy
=head3 dbid =head3 dbid
The dbid of Top100 this dist is listed on. The dbid of Top100 this dist is listed on.
Example: 1
=head3 rank =head3 rank
The rank of this dist on the Top100 list. The rank of this dist on the Top100 list.
Example: 81
=head3 author =head3 author
The author of this dist. The author of this dist.
Example: LBROCARD
=head3 dist =head3 dist
The distribution name. The distribution name.
Example: Tapper-MCP
=head3 score =head3 score
The score of the distribution on the Top100 list. The score of the distribution on the Top100 list.
Example: 153
If the type is: heavy If the type is: heavy
The score is the number of downstream dependencies The score is the number of downstream dependencies
Expand Down
4 changes: 2 additions & 2 deletions lib/CPAN/WWW/Top100/Retrieve/Utils.pm
Expand Up @@ -13,7 +13,7 @@ sub default_top100_uri {
return 'http://ali.as/top100/data.html'; 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 = ( my %dbid_type = (
1 => 'heavy', 1 => 'heavy',
2 => 'volatile', 2 => 'volatile',
Expand Down Expand Up @@ -58,7 +58,7 @@ sub dbids {


=pod =pod
=for stopwords todo Top100 IDs dbid dbids uri =for stopwords Top100 IDs dbid dbids uri
=head1 SYNOPSIS =head1 SYNOPSIS
Expand Down

0 comments on commit 565331c

Please sign in to comment.