Clearly document that sortHash* returns a Tie::IxHash.

Update the tests to assign to a Tie::IxHash to preserve the
sorted order.
This commit is contained in:
Colin Kuskie 2006-11-16 17:50:57 +00:00
parent e1b583a935
commit 9b8f2ab061
2 changed files with 9 additions and 12 deletions

View file

@ -367,7 +367,8 @@ sub round {
=head2 sortHash ( hash )
Sorts a hash by its values. Returns a hash.
Sorts a hash by its values. Returns a Tie::IxHash. You must assign this to
a similarly tied hash to preserve the order.
=head3 hash
@ -388,7 +389,8 @@ sub sortHash {
=head2 sortHashDecending ( hash )
Sorts a hash in decending order by its values. Returns a hash.
Sorts a hash in decending order by its values. Returns a Tie::IxHash.
You must assign this to a similarly tied hash to preserve the order.
=head3 hash