From: Vincent Pit <vince@profvince.com>
Date: Tue, 17 Mar 2015 13:51:51 +0000 (-0300)
Subject: Clarify the descriptions of ->localize{,_elem,_delete}()
X-Git-Tag: v0.03~3
X-Git-Url: http://git.vpit.fr/?a=commitdiff_plain;h=f2cf6ae0570e2cbab53e5dc4ac71a038bdd06366;p=perl%2Fmodules%2FScope-Context.git

Clarify the descriptions of ->localize{,_elem,_delete}()
---

diff --git a/lib/Scope/Context.pm b/lib/Scope/Context.pm
index c57a830..c9b778e 100644
--- a/lib/Scope/Context.pm
+++ b/lib/Scope/Context.pm
@@ -465,7 +465,7 @@ sub reap {
 
     $cxt->localize($what, $value);
 
-Localize the variable described by C<$what> to the value C<$value> when the control flow returns to the scope pointed by the invocant.
+Localize the variable described by C<$what> to the value C<$value> when the control flow returns to the scope pointed by the invocant, until said scope ends.
 
 See L<Scope::Upper/localize> for details.
 
@@ -483,7 +483,7 @@ sub localize {
 
     $cxt->localize_elem($what, $key, $value);
 
-Localize the element C<$key> of the variable C<$what> to the value C<$value> when the control flow returns to the scope pointed by the invocant.
+Localize the element C<$key> of the variable C<$what> to the value C<$value> when the control flow returns to the scope pointed by the invocant, until said scope ends.
 
 See L<Scope::Upper/localize_elem> for details.
 
@@ -501,7 +501,7 @@ sub localize_elem {
 
     $cxt->localize_delete($what, $key);
 
-Delete the element C<$key> from the variable C<$what> when the control flow returns to the scope pointed by the invocant.
+Delete the element C<$key> from the variable C<$what> when the control flow returns to the scope pointed by the invocant, and restore it to its original value when said scope ends.
 
 See L<Scope::Upper/localize_delete> for details.