Fix documentation typos

diff --git a/lib/File/KDBX.pm b/lib/File/KDBX.pm
index 8730266ab66e792bc3f6aefea6bc509567d0a7bc..75de8998988edb9de3da360d10c8329da7395321 100644 (file)
--- a/lib/File/KDBX.pm
+++ b/lib/File/KDBX.pm
@@ -1923,14 +1923,13 @@ __END__
     );
 
     # Save the database to the filesystem
     );
 
     # Save the database to the filesystem

-    $kdbx->dump_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
+    $kdbx->dump_file('passwords.kdbx', 'masterpw changeme');

 
     # Load the database from the filesystem into a new database instance
 
     # Load the database from the filesystem into a new database instance

-    my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
+    my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'masterpw changeme');

 
     # Iterate over database entries, print entry titles
 
     # Iterate over database entries, print entry titles

-    $kdbx2->entries->each(sub {
-        my ($entry) = @_;
+    $kdbx2->entries->each(sub($entry, @) {

         say 'Entry: ', $entry->title;
     });
 
         say 'Entry: ', $entry->title;
     });
 


@@ -2012,8 +2011,7 @@ across different websites. See L</SECURITY> for an overview of security consider
     my $kdbx = File::KDBX->load_file('mypasswords.kdbx', 'master password CHANGEME');
     $kdbx->unlock;  # cause $entry->password below to be defined
 
     my $kdbx = File::KDBX->load_file('mypasswords.kdbx', 'master password CHANGEME');
     $kdbx->unlock;  # cause $entry->password below to be defined
 

-    $kdbx->entries->each(sub {
-        my ($entry) = @_;
+    $kdbx->entries->each(sub($entry, @) {

         say 'Found password for: ', $entry->title;
         say '  Username: ', $entry->username;
         say '  Password: ', $entry->password;
         say 'Found password for: ', $entry->title;
         say '  Username: ', $entry->username;
         say '  Password: ', $entry->password;

diff --git a/lib/File/KDBX/Constants.pm b/lib/File/KDBX/Constants.pm
index c5c9a0554615eb7b750594ee5c5f6fc25934cccd..e5f5f1d0c7b7670c1338072619c0ef0850cc5906 100644 (file)
--- a/lib/File/KDBX/Constants.pm
+++ b/lib/File/KDBX/Constants.pm
@@ -438,7 +438,7 @@ Get a compression constant from an integer or string value.
 
 =head2 :cipher
 
 
 =head2 :cipher
 

-Constants related ciphers:
+Constants related to ciphers:

 
 =for :list
 = C<CIPHER_UUID_AES128>
 
 =for :list
 = C<CIPHER_UUID_AES128>

diff --git a/lib/File/KDBX/Iterator.pm b/lib/File/KDBX/Iterator.pm
index d531697922b5aa38d44dded0877800f170ca3544..bf7b4eb060a284a634d121cfa017856cc0948e75 100644 (file)
--- a/lib/File/KDBX/Iterator.pm
+++ b/lib/File/KDBX/Iterator.pm
@@ -156,6 +156,7 @@ sub each {
 =method where
 
     \&iterator = $iterator->grep(\&query);
 =method where
 
     \&iterator = $iterator->grep(\&query);

+    \&iterator = $iterator->grep(sub($item) { ... });

 
 Get a new iterator draining from an existing iterator but providing only items that pass a test or are matched
 by a query. In its basic form this method is very much like perl's built-in grep function, except for
 
 Get a new iterator draining from an existing iterator but providing only items that pass a test or are matched
 by a query. In its basic form this method is very much like perl's built-in grep function, except for


@@ -319,7 +320,7 @@ sub nsort_by { shift->norder_by(@_) }
 
 Get a new iterator draining from an existing iterator but providing only a limited number of items.
 
 
 Get a new iterator draining from an existing iterator but providing only a limited number of items.
 

-C<limit> as an alias for L<< Iterator::Simple/"$iterator->head($count)" >>.
+C<limit> is an alias for L<< Iterator::Simple/"$iterator->head($count)" >>.

 
 =cut
 
 
 =cut
 


@@ -394,7 +395,7 @@ __END__
 
 A buffered iterator compatible with and expanding upon L<Iterator::Simple>, this provides an easy way to
 navigate a L<File::KDBX> database. The documentation for B<Iterator::Simple> documents functions and methods
 
 A buffered iterator compatible with and expanding upon L<Iterator::Simple>, this provides an easy way to
 navigate a L<File::KDBX> database. The documentation for B<Iterator::Simple> documents functions and methods

-supported but this iterator that are not documented here, so consider that additional reading.
+supported by this iterator that are not documented here, so consider that additional reading.

 
 =head2 Buffer
 
 
 =head2 Buffer
 


@@ -416,4 +417,7 @@ B<File::KDBX> lists which are always finite -- unless you do something weird lik
 its own ancestor -- but I'm noting it here as a potential issue if you use this iterator class for other
 things (which you probably shouldn't do).
 
 its own ancestor -- but I'm noting it here as a potential issue if you use this iterator class for other
 things (which you probably shouldn't do).
 

+KDBX databases are always fully-loaded into memory anyway, so there's not a significant memory cost to
+draining an iterator completely.
+

 =cut
 =cut