Bug #79199 for Algorithm-Diff: "Documentation bug" for key-generation call in object interface

Thanks for Algorithm::Diff! I had some difficulty figuring out how to call my own comparison subroutines using the oo interface, and would like to suggest the following patch to the documentation, which just adds the following lines to the pod: ------ For the OO interface, the key generation function should be passed as an anonymous hash with the hash-key 'keyGen': sub ignore_letter_case { return uc(shift()); } my $diff = Algorithm::Diff->new(\@list1,\@list2, { keyGen => \&ignore_letter_case } ); ------ The 'obvious' syntax: my $diff = Algorithm::Diff->new(\@list1,\@list2, \& my_comparison_sub ); # WRONG! gave this error: Not a HASH reference at /opt/local/lib/perl5/site_perl/5.12.3/Algorithm/Diff.pm line 589. ... and it took me a little while (and a peek into the source) to figure out what was wanted. Thanks, -- Will Fischer Here's the patch (also attached as a file): % LC_ALL=C TZ=UTC0 diff -Naur old/Diff.pm new/Diff.pm --- old/Diff.pm 2006-07-31 05:55:36.000000000 +0000 +++ new/Diff.pm 2012-08-24 16:42:34.000000000 +0000 @@ -1662,6 +1662,13 @@ You may also pass additional parameters to the key generation function if you wish. +For the OO interface, the key generation function should be passed as +an anonymous hash with the hash-key 'keyGen': + +sub ignore_letter_case { return uc(shift()); } + +my $diff = Algorithm::Diff->new(\@list1,\@list2, { keyGen => \&ignore_letter_case } ); + =head1 ERROR CHECKING If you pass these routines a non-reference and they expect a reference, Show quoted text