clarify documentation about Sub::Quote's captured variables not being aliases

diff --git a/Changes b/Changes
index 5baa9a9..e73a063 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,3 +1,4 @@
+  - clarify in docs that Sub::Quote's captured variables are copies, not aliases
   - fix infinite recursion if an isa check fails due to another isa check
     (RT#87575)
   - fix Sub::Quote and Sub::Defer under threads (RT#87043)

diff --git a/lib/Sub/Quote.pm b/lib/Sub/Quote.pm
index 3c12c61..9b3d53a 100644 (file)
--- a/lib/Sub/Quote.pm
+++ b/lib/Sub/Quote.pm
@@ -167,7 +167,10 @@ C<$name> is the subroutine where the coderef will be installed.
 C<$code> is a string that will be turned into code.
 
 C<\%captures> is a hashref of variables that will be made available to the
-code.  See the L</SYNOPSIS>'s C<Silly::dagron> for an example using captures.
+code.  The keys should be the full name of the variable to be made available,
+including the sigil.  The values should be references to the values.  The
+variables will contain copies of the values.  See the L</SYNOPSIS>'s
+C<Silly::dagron> for an example using captures.
 
 =head3 options