changeset 79:40a552fe2dbc

Clarify operation of reduce phase when grouping insensitively
author Lewin Bormann <lbo@spheniscida.de>
date Sun, 07 Feb 2016 09:50:59 +0000
parents 64de3fd37c35
children fe31ac3158c3
files src/parameters.rs
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/parameters.rs	Sun Feb 07 09:38:34 2016 +0000
+++ b/src/parameters.rs	Sun Feb 07 09:50:59 2016 +0000
@@ -71,7 +71,8 @@
     /// buffers)
     /// Default 1.
     ///
-    /// insensitive: Whether to group strings together that differ in case.
+    /// insensitive: Whether to group strings together that differ in case. When used, the first
+    /// encountered key will be supplied as key to the reduce function.
     /// BUG: This will not work correctly until the map phase delivers outputs in the correct order, i.e.
     /// dictionary order. The default Ord implementation for String treats lower and upper case
     /// very differently. Default: false.