]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
clarify precedence docs
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 3 Oct 2022 15:40:27 +0000 (11:40 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 3 Oct 2022 15:41:09 +0000 (11:41 -0400)
Change-Id: I748f2736eb6382c8625b3419a82785b48766d8f7
references: #8584
(cherry picked from commit b295a3b58f13d566c37244448218e4287f5e47ee)

lib/sqlalchemy/sql/operators.py

index 1da50322967d580d961f9ed69b4e45b48112c6c0..806d41eaf88254dbaff3a38a8e88f1bba03337a7 100644 (file)
@@ -145,13 +145,20 @@ class Operators(object):
           between this element and the expression passed to the
           generated function.
 
-        :param precedence: precedence to apply to the operator, when
-         parenthesizing expressions.  A lower number will cause the expression
-         to be parenthesized when applied against another operator with
-         higher precedence.  The default value of ``0`` is lower than all
-         operators except for the comma (``,``) and ``AS`` operators.
-         A value of 100 will be higher or equal to all operators, and -100
-         will be lower than or equal to all operators.
+        :param precedence: precedence which the database is expected to apply
+         to the operator in SQL expressions. This integer value acts as a hint
+         for the SQL compiler to know when explicit parenthesis should be
+         rendered around a particular operation. A lower number will cause the
+         expression to be parenthesized when applied against another operator
+         with higher precedence. The default value of ``0`` is lower than all
+         operators except for the comma (``,``) and ``AS`` operators. A value
+         of 100 will be higher or equal to all operators, and -100 will be
+         lower than or equal to all operators.
+
+         .. seealso::
+
+            :ref:`faq_sql_expression_op_parenthesis` - detailed description
+            of how the SQLAlchemy SQL compiler renders parenthesis
 
         :param is_comparison: legacy; if True, the operator will be considered
          as a "comparison" operator, that is which evaluates to a boolean