diff roundup/hyperdb.py @ 4935:adb8b787e157

Attempt to clarify hyperdb.Proptree meaning
author anatoly techtonik <techtonik@gmail.com>
date Thu, 02 Oct 2014 16:57:28 +0300
parents 2ba982dcdf2c
children 0a05c4d9a221
line wrap: on
line diff
--- a/roundup/hyperdb.py	Wed Oct 01 11:33:22 2014 +0300
+++ b/roundup/hyperdb.py	Thu Oct 02 16:57:28 2014 +0300
@@ -293,13 +293,12 @@
     return m.group(1), m.group(2)
 
 class Proptree(object):
-    """ Simple tree data structure for optimizing searching of
-    properties. Each node in the tree represents a roundup Class
-    Property that has to be navigated for finding the given search
-    or sort properties. The need_for attribute is used for
-    distinguishing nodes in the tree used for sorting, searching or
-    retrieval: The attribute is a dictionary containing one or several
-    of the values 'sort', 'search', 'retrieve'.
+    """ Simple tree data structure for property lookup. Each node in
+    the tree is a roundup Class Property that has to be navigated to
+    find given property. The need_for attribute is used to mark nodes
+    that are used for sorting, searching or retrieval: The attribute
+    is a dictionary containing one or several of the values 'sort',
+    'search', 'retrieve'.
 
     The Proptree is also used for transitively searching attributes for
     backends that do not support transitive search (e.g. anydbm). The

Roundup Issue Tracker: http://roundup-tracker.org/