From bc35a7aa1ee5a59a30270f845112b06393e7cd0d Mon Sep 17 00:00:00 2001
From: Russell Brown <russell.brown@mac.com>
Date: Wed, 19 Sep 2018 16:28:28 +0100
Subject: [PATCH] Update docs to clarify that regex cannot be run on integers

---
 src/leveled_bookie.erl | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/leveled_bookie.erl b/src/leveled_bookie.erl
index 9ee34dd..6289508 100644
--- a/src/leveled_bookie.erl
+++ b/src/leveled_bookie.erl
@@ -574,7 +574,11 @@ book_returnfolder(Pid, RunnerType) ->
 %% expression of type `re:mp()' (that will be run against each index
 %% term value, and only those that match will be accumulated) or
 %% `undefined', which means no regular expression filtering of index
-%% values.
+%% values. NOTE: Regular Expressions can ONLY be run on indexes that
+%% have binary or string values, NOT integer values. In the Riak sense
+%% of secondary indexes, there are two types of indexes `_bin' indexes
+%% and `_int' indexes. Term regex may only be run against the `_bin'
+%% type.
 -spec book_indexfold(pid(),
                      Constraint:: {Bucket, Key} | Bucket,
                      FoldAccT :: {FoldFun, Acc},