From: Anton Kovalevich <kai3341@gmail.com>
Date: Fri, 26 Mar 2021 02:06:58 +0000 (+0300)
Subject: docstring fix + design fix
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=05c3da43fed0ae29a4c36a9f27446889ae4f5799;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

docstring fix + design fix
---

diff --git a/lib/sqlalchemy/dialects/mysql/expression.py b/lib/sqlalchemy/dialects/mysql/expression.py
index c8da18549f..d3e1c14c7b 100644
--- a/lib/sqlalchemy/dialects/mysql/expression.py
+++ b/lib/sqlalchemy/dialects/mysql/expression.py
@@ -1,24 +1,27 @@
 from ...sql.elements import ClauseElementBatch
 
 
-def match(*clauselist, against, **kwargs):
+def match(*clauselist, against, modifier=None, **kwargs):
     """Produce a ``MATCH (X, Y) AGAINST ('TEXT')`` clause.
 
     E.g.::
 
-        from sqlalchemy import match
+        from sqlalchemy.mysql.dialects.mysql.expression import match
+
+        from sqlalchemy.mysql.dialects.mysql.expression_enum \
+            import MatchExpressionModifier
 
         match_columns_where = match(
             users_table.c.firstname,
             users_table.c.lastname,
             against="John Connor",
+            modifier=MatchExpressionModifier.in_boolean_mode,
         )
 
         match_columns_order = match(
             users_table.c.firstname,
             users_table.c.lastname,
             against="John Connor",
-            boolean_mode=False,
         )
 
         stmt = select(users_table)\
@@ -45,7 +48,10 @@ def match(*clauselist, against, **kwargs):
      scalar expression to be coerced into a column expression,
      serving as the ``MATCH`` side of expression.
 
-    :param against: str.
+    :param modifier: ``None`` or member of
+     :class:`.expression_enum.MatchExpressionModifier`.
+
+    :
 
      .. versionadded:: 1.4.4
 
@@ -56,4 +62,4 @@ def match(*clauselist, against, **kwargs):
     """
 
     clause_batch = ClauseElementBatch(*clauselist, group=False)
-    return clause_batch.match(against, **kwargs)
+    return clause_batch.match(against, modifier=modifier, **kwargs)