This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Tiny pod tweaks.
authorJarkko Hietaniemi <jhi@iki.fi>
Tue, 12 Mar 2002 16:45:32 +0000 (16:45 +0000)
committerJarkko Hietaniemi <jhi@iki.fi>
Tue, 12 Mar 2002 16:45:32 +0000 (16:45 +0000)
p4raw-id: //depot/perl@15203

lib/Hash/Util.pm

index f6fed97..528711a 100644 (file)
@@ -11,7 +11,6 @@ our @EXPORT_OK  = qw(lock_keys unlock_keys lock_value unlock_value
                     );
 our $VERSION    = 0.04;
 
-
 =head1 NAME
 
 Hash::Util - A selection of general-utility hash subroutines
@@ -20,8 +19,7 @@ Hash::Util - A selection of general-utility hash subroutines
 
   use Hash::Util qw(lock_keys   unlock_keys 
                     lock_value  unlock_value
-                    lock_hash   unlock_hash
-                   );
+                    lock_hash   unlock_hash);
 
   %hash = (foo => 42, bar => 23);
   lock_keys(%hash);
@@ -34,7 +32,6 @@ Hash::Util - A selection of general-utility hash subroutines
   lock_hash  (%hash);
   unlock_hash(%hash);
 
-
 =head1 DESCRIPTION
 
 C<Hash::Util> contains special functions for manipulating hashes that
@@ -60,13 +57,13 @@ This is intended to largely replace the deprecated pseudo-hashes.
   lock_keys(%hash);
   lock_keys(%hash, @keys);
 
-  unlock_keys(%hash;)
-
 Restricts the given %hash's set of keys to @keys.  If @keys is not
 given it restricts it to its current keyset.  No more keys can be
 added.  delete() and exists() will still work, but it does not effect
 the set of allowed keys.
 
+  unlock_keys(%hash;)
+
 Removes the restriction on the %hash's keyset.
 
 =cut
@@ -138,14 +135,15 @@ sub unlock_value (\%$) {
 =item B<unlock_hash>
 
     lock_hash(%hash);
-    unlock_hash(%hash);
 
 lock_hash() locks an entire hash, making all keys and values readonly.
 No value can be changed, no keys can be added or deleted.
 
-unlock_hash() does the opposite.  All keys and values are made
-read/write.  All values can be changed and keys can be added and
-deleted.
+    unlock_hash(%hash);
+
+unlock_hash() does the opposite of lock_hash().  All keys and values
+are made read/write.  All values can be changed and keys can be added
+and deleted.
 
 =cut