Careful though. In the Perl docs, EXPR means an expression evaluated in scalar context, so you shouldn't be using EXPR in your own documentation (unless you use prototypes to ensure this). Might I recommend using meaningful variable names instead? A sample from WWW::Kickstarter:
=head2 project_rewards my @rewards = $ks->project_rewards($project_id); my @rewards = $ks->project_rewards($project_slug); Fetches and returns the rewards of the specified project as L<WWW::Kic +kstarter::Data::Reward> objects. The argument may be the project's numerical id (as returned by L<C<< $ +project->id >>|WWW::Kickstarter::Data::Project/id>) or its "slug" (as returned by L<C<< $project->slug >>|WWW::Kickstarter::D +ata::Project/slug>).
my @rewards = $ks->project_rewards($project_id); my @rewards = $ks->project_rewards($project_slug);
Fetches and returns the rewards of the specified project as WWW::Kickstarter::Data::Reward objects.
The argument may be the project's numerical id (as returned by $project->id) or its "slug" (as returned by $project->slug).
In reply to Re^2: More comprehensive style guide for Perl docs than perlpodstyle?
by ikegami
in thread More comprehensive style guide for Perl docs than perlpodstyle?
by nysus
| For: | Use: | ||
| & | & | ||
| < | < | ||
| > | > | ||
| [ | [ | ||
| ] | ] |