From b8429d44314a02da9b5ebc17fa0a9284543aa825 Mon Sep 17 00:00:00 2001
From: Muhammad Haseeb <14217455+mhaseeb123@users.noreply.github.com>
Date: Tue, 26 Nov 2024 11:24:23 -0800
Subject: [PATCH] Doc update for `cuco::arrow_filter_policy` (#646)

This PR updates docstring for `cuco::arrow_filter_policy` reflecting the
recent change allowing taking in a custom `xxhash_64` hasher along with
a couple other minor changes
---
 include/cuco/detail/bloom_filter/arrow_filter_policy.cuh | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh b/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh
index e1f1b641a..edb88e6e0 100644
--- a/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh
+++ b/include/cuco/detail/bloom_filter/arrow_filter_policy.cuh
@@ -40,14 +40,15 @@ namespace cuco::detail {
  * void bulk_insert_and_eval_arrow_policy_bloom_filter(device_vector<KeyType> const& positive_keys,
  *                                                 device_vector<KeyType> const& negative_keys)
  * {
- *     using policy_type = cuco::arrow_filter_policy<key_type>;
+ *     using xxhash_64 = cuco::xxhash_64<KeyType>;
+ *     using policy_type = cuco::arrow_filter_policy<KeyType, xxhash_64>;
  *
  *     // Warn or throw if the number of filter blocks is greater than maximum used by Arrow policy.
  *     static_assert(NUM_FILTER_BLOCKS <= policy_type::max_filter_blocks, "NUM_FILTER_BLOCKS must be
  *                                                                         in range: [1, 4194304]");
  *
  *     // Create a bloom filter with Arrow policy
- *     cuco::bloom_filter<key_type, cuco::extent<size_t>,
+ *     cuco::bloom_filter<KeyType, cuco::extent<size_t>,
  *         cuda::thread_scope_device, policy_type> filter{NUM_FILTER_BLOCKS};
  *
  *     // Add positive keys to the bloom filter