POD cleanup

[perl/modules/indirect.git] / lib / indirect.pm

diff --git a/lib/indirect.pm b/lib/indirect.pm
index 6354a1361f30c36af3a672f88a8579d03b9928e0..3efbb808971990248c016ce19e757ecccbfcf531 100644 (file)
--- a/lib/indirect.pm
+++ b/lib/indirect.pm
@@ -22,20 +22,34 @@ BEGIN {
 
 =head1 SYNOPSIS
 
+    # In a script
     no indirect;
     my $x = new Apple 1, 2, 3; # warns
     {
      use indirect;
      my $y = new Pear; # ok
+     {
+      no indirect hook => sub { die "You really wanted $_[0]\->$_[1]" };
+      my $z = new Pineapple 'fresh'; # croaks 'You really wanted Pineapple->new'
+     }
     }
     no indirect ':fatal';
     if (defied $foo) { ... } # croaks, note the typo
 
+    # From the command-line
+    perl -M-indirect -e 'my $x = new Banana;' # warns
+
+    # Or each time perl is ran
+    export PERL5OPT="-M-indirect"
+    perl -e 'my $y = new Coconut;' # warns
+
 =head1 DESCRIPTION
 
-When enabled (or disabled as some may prefer to say, since you actually turn it on by calling C<no indirect>), this pragma warns about indirect object syntax constructs that may have slipped into your code. This syntax is now considered harmful, since its parsing has many quirks and its use is error prone (when C<sub> isn't defined, C<sub $x> is actually interpreted as C<< $x->sub >>).
+When enabled (or disabled as some may prefer to say, since you actually turn it on by calling C<no indirect>), this pragma warns about indirect object syntax constructs that may have slipped into your code.
+This syntax is now considered harmful, since its parsing has many quirks and its use is error prone (when C<sub> isn't defined, C<sub $x> is actually interpreted as C<< $x->sub >>).
 
-It currently does not warn when the object is enclosed between braces (like C<meth { $obj } @args>) or for core functions (C<print> or C<say>). This may change in the future, or may be added as optional features that would be enabled by passing options to C<unimport>.
+It currently does not warn when the object is enclosed between braces (like C<meth { $obj } @args>) or for core functions (C<print> or C<say>).
+This may change in the future, or may be added as optional features that would be enabled by passing options to C<unimport>.
 
 This module is B<not> a source filter.
 
@@ -133,7 +147,8 @@ You can contact me by mail or on C<irc.perl.org> (vincent).
 
 =head1 BUGS
 
-Please report any bugs or feature requests to C<bug-indirect at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=indirect>.  I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-indirect at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=indirect>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT