From 7229aadcec72e930514b34ad862a31a524be5edf Mon Sep 17 00:00:00 2001 From: Guilherme Andrade Date: Sat, 23 Apr 2016 21:57:42 +0100 Subject: [PATCH] Update docs --- README.md | 4 +++- doc/erlquad.html | 2 +- doc/overview-summary.html | 6 ++++-- doc/overview.edoc | 4 +++- doc/utf8/README.md | 4 +++- 5 files changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2c1f9cd..150e574 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,9 @@ __Authors:__ Guilherme Andrade ([`erlquad(at)gandrade(dot)net`](mailto:erlquad(a `erlquad` is a straightforward Erlang implementation of [quadtrees](https://en.wikipedia.org/wiki/Quadtree), supporting both bounding-box outlines as well as precise coordinates for small enough objects. -It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so. +It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so. + +Buckets have unlimited capacity and depth is fixed on initialization. ```erlang diff --git a/doc/erlquad.html b/doc/erlquad.html index 33b518d..3b2f05b 100644 --- a/doc/erlquad.html +++ b/doc/erlquad.html @@ -110,6 +110,6 @@

objects_fold/3


-

Generated by EDoc, Apr 23 2016, 21:49:36.

+

Generated by EDoc, Apr 23 2016, 21:57:16.

diff --git a/doc/overview-summary.html b/doc/overview-summary.html index 9e639e6..ddcf948 100644 --- a/doc/overview-summary.html +++ b/doc/overview-summary.html @@ -17,7 +17,9 @@

erlquad

erlquad is a straightforward Erlang implementation of quadtrees, supporting both bounding-box outlines as well as precise coordinates for small enough objects.

-

It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.

+

It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.

+ +

Buckets have unlimited capacity and depth is fixed on initialization.

 Object1 = #big_square{ x = 1000, y = 750,  side = 10 },
@@ -67,6 +69,6 @@ 

erlquad


-

Generated by EDoc, Apr 23 2016, 21:49:36.

+

Generated by EDoc, Apr 23 2016, 21:57:16.

diff --git a/doc/overview.edoc b/doc/overview.edoc index 4fcc67c..7e32270 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -8,7 +8,9 @@ `erlquad' is a straightforward Erlang implementation of quadtrees, supporting both bounding-box outlines as well as precise coordinates for small enough objects. -It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so. +It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so. + +Buckets have unlimited capacity and depth is fixed on initialization.
 Object1 = #big_square{ x = 1000, y = 750,  side = 10 },
diff --git a/doc/utf8/README.md b/doc/utf8/README.md
index 181dc43..2754cfd 100644
--- a/doc/utf8/README.md
+++ b/doc/utf8/README.md
@@ -13,7 +13,9 @@ __Authors:__ Guilherme Andrade ([`erlquad(at)gandrade(dot)net`](mailto:erlquad(a
 
 `erlquad` is a straightforward Erlang implementation of [quadtrees](https://en.wikipedia.org/wiki/Quadtree), supporting both bounding-box outlines as well as precise coordinates for small enough objects.
 
-It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. 'Deeplist' versions of fetching methods are also included for when there's no need to concatenate the final results and thus avoid the overhead of doing so.
+It exposes functions for fetching, folding and any'ing (with boolean predicate) particular areas of interest as well as all contained objects. Deeplist versions of fetching methods are also included for when there's no need to concatenate the intermediate results and thus avoid the overhead of doing so.
+
+Buckets have unlimited capacity and depth is fixed on initialization.
 
 ```erlang