-fix datacache to return 2x num_closest in both directions

1 files changed, 6 insertions, 5 deletions

diff --git a/src/include/gnunet_datacache_plugin.h b/src/include/gnunet_datacache_plugin.h
index 914aaf15c..34bf5f277 100644
--- a/src/include/gnunet_datacache_plugin.h
+++ b/src/include/gnunet_datacache_plugin.h
@@ -158,15 +158,16 @@ struct GNUNET_DATACACHE_PluginFunctions
 
 
   /**
-   * Iterate over the results that are "close" to a particular key in
-   * the datacache.  "close" is defined as numerically larger than @a
-   * key (when interpreted as a circular address space), with small
-   * distance.
+   * Iterate over the results that are "close" to a particular key in the
+   * datacache.  "close" is defined as returning the @a num_results that are
+   * numerically closest and larger than @a key and also @a num_results that
+   * are numerically lower than @a key. Thus, the maximum number of results
+   * returned is actually twice @a num_results.
    *
    * @param cls closure (internal context for the plugin)
    * @param key area of the keyspace to look into
    * @param type desired block type for the replies
-   * @param num_results number of results that should be returned to @a iter
+   * @param num_results half the number of results that should be returned to @a iter
    * @param iter maybe NULL (to just count)
    * @param iter_cls closure for @a iter
    * @return the number of results found