Small POD fixup

[perl/modules/Scope-Upper.git] / lib / Scope / Upper.pm

diff --git a/lib/Scope/Upper.pm b/lib/Scope/Upper.pm
index ac254177da01cc448839ab2d38c3f6a8fcb5bd20..6ca286c47db5955d27f0f186b2443d06f56eacaa 100644 (file)
--- a/lib/Scope/Upper.pm
+++ b/lib/Scope/Upper.pm
@@ -170,7 +170,7 @@ localize variables, array/hash values or deletions of elements in higher context
 
 =item *
 
-return values immediately to an upper level with L</unwind> and L</yield>, and know which context was in use then with L</want_at> ;
+return values immediately to an upper level with L</unwind>, L</yield> and L</leave>, and know which context was in use then with L</want_at> ;
 
 =item *
 
@@ -340,14 +340,22 @@ Hence you can use it to return values from a C<do> or a C<map> block :
 
 Like for L</unwind>, the upper context isn't coerced onto C<@values>.
 
+=head2 C<leave>
+
+    leave;
+    leave @values;
+
+Immediately returns C<@values> from the current block, whatever it may be (besides a C<s///e> substitution context).
+C<leave> is actually a synonym for C<unwind HERE>, while C<leave @values> is a synonym for C<yield @values, HERE>.
+
 =head2 C<want_at>
 
     my $want = want_at;
     my $want = want_at $context;
 
-Like C<wantarray>, but for the subroutine/eval/format at or just above C<$context>.
+Like L<perlfunc/wantarray>, but for the subroutine, eval or format context located at or just above C<$context>.
 
-The previous example can then be "corrected" :
+It can be used to revise the example showed in L</unwind> :
 
     my $num = sub {
      my @a = ('a' .. 'z');
@@ -638,7 +646,7 @@ Where L</unwind>, L</yield>, L</want_at> and L</uplevel> point to depending on t
 
 =head1 EXPORT
 
-The functions L</reap>, L</localize>, L</localize_elem>, L</localize_delete>,  L</unwind>, L</yield>, L</want_at> and L</uplevel> are only exported on request, either individually or by the tags C<':funcs'> and C<':all'>.
+The functions L</reap>, L</localize>, L</localize_elem>, L</localize_delete>,  L</unwind>, L</yield>, L</leave>, L</want_at> and L</uplevel> are only exported on request, either individually or by the tags C<':funcs'> and C<':all'>.
 
 The constant L</SU_THREADSAFE> is also only exported on request, individually or by the tags C<':consts'> and C<':all'>.
 
@@ -653,7 +661,7 @@ our %EXPORT_TAGS = (
  funcs  => [ qw<
   reap
   localize localize_elem localize_delete
-  unwind yield
+  unwind yield leave
   want_at
   uplevel
   uid validate_uid
@@ -718,7 +726,12 @@ Despite this shortcoming, this XS version of L</uplevel> should still run way fa
 
 =head1 DEPENDENCIES
 
-L<XSLoader> (standard since perl 5.006).
+L<perl> 5.6.
+
+A C compiler.
+This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
+
+L<XSLoader> (core since perl 5.006).
 
 =head1 SEE ALSO