squash w/ 182. code review - docs

README.md

@@ -429,9 +429,9 @@ The following arguments are strictly optional and may be used either in `Query`'
         - The `case_sensitive` constructor parameter is ignored.
         - The `options` constructor parameter is ignored.
         - The `total_rows` member function of the `Query` class always returns `None`.
-  * *order_by* is a string holding the sorting instructions for a GenQuery2 query. Defaults to an empty string. Only used by the GenQuery2 parser.
+  * *order_by* is a string holding the sorting instructions for a GenQuery2 query. Defaults to an empty string. Only recognized by the GenQuery2 parser.
 
-As a best practice, when using GenQuery2, prefer calling the `close()` member function when done processing the resultset. Doing this will instruct the server to immediately free any resources allocated to the `Query` object. This is extremely important when multiple `Query` objects are executed within a single rule.
+When a GenQuery2 resultset is done being processed, it is best practice to call the `close()` member function. Doing this will instruct the server to immediately free any resources allocated to the `Query` object. This is extremely important when multiple `Query` objects are executed within a single rule.
 
 # Questions and Answers
 

genquery.py

@@ -62,8 +62,8 @@ class Query(object):
     :param limit:          (optional) maximum amount of results, can be used for pagination
     :param case_sensitive: (optional) set this to False to make the entire where-clause case insensitive
     :param options:        (optional) other OR-ed options to pass to the query (see the Option type above)
-    :param parser:         (optional) the GenQuery engine to use. defaults to Parser.GENQUERY1.
-    :param order_by:       (optional) order-by clause, as a string. defaults to an empty string. applies when using the GenQuery2 parser
+    :param parser:         (optional) the GenQuery engine to use. defaults to Parser.GENQUERY1
+    :param order_by:       (optional) order-by clause, as a string. defaults to an empty string. only recognized by the GenQuery2 parser
 
     GenQuery2 parser: