A better explaination of how string symbols work

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

diff --git a/lib/Scope/Upper.pm b/lib/Scope/Upper.pm
index 30f94547df8d937db1481de5b8bfdfa76e1ea1c0..91219ff91e5b7fcd63cf1027d022412d35bce5d1 100644 (file)
--- a/lib/Scope/Upper.pm
+++ b/lib/Scope/Upper.pm
@@ -144,11 +144,23 @@ will set C<$x> to a reference to the string C<'foo'>.
 Other sigils (C<'@'>, C<'%'>, C<'&'> and C<'*'>) require C<$value> to be a reference of the corresponding type.
 
 When the symbol is given by a string, it is resolved when the actual localization takes place and not when C<localize> is called.
-This means that
+Thus, if the symbol name is not qualified, it will refer to the variable in the package where the localization actually takes place and not in the one where the C<localize> call was compiled.
+For example,
+
+    {
+     package Scope;
+     sub new { localize '$tag', $_[0] => UP }
+    }
 
-    sub tag { localize '$x', $_[0] => UP }
+    {
+     package Tool;
+     {
+      Scope->new;
+      ...
+     }
+    }
 
-will localize in the caller's namespace.
+will localize C<$Tool::tag> and not C<$Scope::tag>.
 
 =back
 
@@ -389,7 +401,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-scope-upper at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Scope-Upper>.  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-scope-upper at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Scope-Upper>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 
 =head1 SUPPORT