This is 0.11

[perl/modules/autovivification.git] / README

diff --git a/README b/README
index 0cb0b9eff4189c69aeb581b3c7550456b649f5b9..7d750e7808d1437e2e9f1ff45299340f0d8e37cf 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ NAME
     autovivification - Lexically disable autovivification.
 
 VERSION
-    Version 0.10
+    Version 0.11
 
 SYNOPSIS
         no autovivification;
@@ -23,9 +23,9 @@ DESCRIPTION
     When an undefined variable is dereferenced, it gets silently upgraded to
     an array or hash reference (depending of the type of the dereferencing).
     This behaviour is called *autovivification* and usually does what you
-    mean (e.g. when you store a value) but it's sometimes unnatural or
-    surprising because your variables gets populated behind your back. This
-    is especially true when several levels of dereferencing are involved, in
+    mean (e.g. when you store a value) but it may be unnatural or surprising
+    because your variables gets populated behind your back. This is
+    especially true when several levels of dereferencing are involved, in
     which case all levels are vivified up to the last, or when it happens in
     intuitively read-only constructs like "exists".
 
@@ -33,7 +33,12 @@ DESCRIPTION
     optionally throws a warning or an error when it would have happened.
 
 METHODS
-  "unimport @opts"
+  "unimport"
+        no autovivification; # defaults to qw<fetch exists delete>
+        no autovivification qw<fetch store exists delete>;
+        no autovivification 'warn';
+        no autovivification 'strict';
+
     Magically called when "no autovivification @opts" is encountered.
     Enables the features given in @opts, which can be :
 
@@ -91,7 +96,7 @@ METHODS
 
         An exception is thrown if vivification is needed to store the value,
         which means that effectively you can only assign to levels that are
-        already defined In the example, this would require $arrayref (resp.
+        already defined. In the example, this would require $arrayref (resp.
         $hashref) to already be an array (resp. hash) reference.
 
     *   'warn'
@@ -107,7 +112,10 @@ METHODS
 
     When @opts is empty, it defaults to "qw<fetch exists delete>".
 
-  "import @opts"
+  "import"
+        use autovivification; # default Perl behaviour
+        use autovivification qw<fetch store exists delete>;
+
     Magically called when "use autovivification @opts" is encountered.
     Disables the features given in @opts, which can be the same as for
     "unimport".
@@ -120,19 +128,19 @@ METHODS
 
 CONSTANTS
   "A_THREADSAFE"
-    True iff the module could have been built with thread-safety features
-    enabled. This constant only has a meaning with your perl is threaded ;
-    otherwise, it'll always be false.
+    True if and only if the module could have been built with thread-safety
+    features enabled. This constant only has a meaning when your perl is
+    threaded, otherwise it will always be false.
 
   "A_FORKSAFE"
-    True iff this module could have been built with fork-safety features
-    enabled. This will always be true except on Windows where it's false for
-    perl 5.10.0 and below .
+    True if and only if this module could have been built with fork-safety
+    features enabled. This constant will always be true, except on Windows
+    where it is false for perl 5.10.0 and below.
 
 CAVEATS
     The pragma doesn't apply when one dereferences the returned value of an
     array or hash slice, as in "@array[$id]->{member}" or
-    @hash{$key}->{member}. This syntax is valid Perl, yet it's discouraged
+    @hash{$key}->{member}. This syntax is valid Perl, yet it is discouraged
     as the slice is here useless since the dereferencing enforces scalar
     context. If warnings are turned on, Perl will complain about one-element
     slices.
@@ -172,7 +180,7 @@ ACKNOWLEDGEMENTS
     Matt S. Trout asked for it.
 
 COPYRIGHT & LICENSE
-    Copyright 2009,2010,2011 Vincent Pit, all rights reserved.
+    Copyright 2009,2010,2011,2012,2013 Vincent Pit, all rights reserved.
 
     This program is free software; you can redistribute it and/or modify it
     under the same terms as Perl itself.