]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Convert most "See also" phrases into .. seealso::
authorMike Bayer <mike_mp@zzzcomputing.com>
Tue, 15 Jan 2019 21:12:39 +0000 (16:12 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 15 Jan 2019 21:13:25 +0000 (16:13 -0500)
Change-Id: Ie32598b895c1c5f5bce7c8e1573abbcfe9d434a8
(cherry picked from commit e81d3815abb36c52b0019dee6e4f67990e3d1c7d)

12 files changed:
doc/build/orm/mapping_columns.rst
doc/build/orm/session_basics.rst
lib/sqlalchemy/engine/base.py
lib/sqlalchemy/events.py
lib/sqlalchemy/orm/descriptor_props.py
lib/sqlalchemy/orm/interfaces.py
lib/sqlalchemy/orm/properties.py
lib/sqlalchemy/orm/relationships.py
lib/sqlalchemy/pool.py
lib/sqlalchemy/sql/operators.py
lib/sqlalchemy/sql/sqltypes.py
lib/sqlalchemy/sql/type_api.py

index 4b31b92102c91089d0835fe58447362c4368b85c..e07692388532f4b5620d47f6d5ff01956fafce18 100644 (file)
@@ -207,16 +207,18 @@ should be included or excluded::
 
 .. note::
 
-   insert and update defaults configured on individual
-   :class:`.Column` objects, i.e. those described at :ref:`metadata_defaults`
-   including those configured by the ``default``, ``update``,
-   ``server_default`` and ``server_onupdate`` arguments, will continue to
-   function normally even if those :class:`.Column` objects are not mapped.
-   This is because in the case of ``default`` and ``update``, the
-   :class:`.Column` object is still present on the underlying
-   :class:`.Table`, thus allowing the default functions to take place when
-   the ORM emits an INSERT or UPDATE, and in the case of ``server_default``
-   and ``server_onupdate``, the relational database itself maintains these
-   functions.
+    insert and update defaults configured on individual :class:`.Column`
+    objects, i.e. those described at :ref:`metadata_defaults` including those
+    configured by the :paramref:`.Column.default`,
+    :paramref:`.Column.onupdate`, :paramref:`.Column.server_default` and
+    :paramref:`.Column.server_onupdate` parameters, will continue to function
+    normally even if those :class:`.Column` objects are not mapped. This is
+    because in the case of :paramref:`.Column.default` and
+    :paramref:`.Column.onupdate`, the :class:`.Column` object is still present
+    on the underlying :class:`.Table`, thus allowing the default functions to
+    take place when the ORM emits an INSERT or UPDATE, and in the case of
+    :paramref:`.Column.server_default` and :paramref:`.Column.server_onupdate`,
+    the relational database itself emits these defaults as a server side
+    behavior.
 
 
index 6f3500abbbde2b881336c2e9cac00e623d5fc43c..4547e124361901ebb530980274b724bf48a915b3 100644 (file)
@@ -664,7 +664,9 @@ it will be deleted on flush::
     some_user.preference = None
     session.flush()  # will delete the Preference object
 
-See also :ref:`unitofwork_cascades` for detail on cascades.
+.. seealso::
+
+    :ref:`unitofwork_cascades` for detail on cascades.
 
 
 Deleting based on Filter Criterion
index 95b69ed3eaa9c85edff6eae4e16b108d9c19c240..ba73cb105c206446ee69ecd9b1c5a258af0b2d00 100644 (file)
@@ -586,14 +586,14 @@ class Connection(Connectable):
         :class:`.Transaction` objects will roll back the
         transaction.
 
-        See also:
+        .. seealso::
 
-        :meth:`.Connection.begin_nested` - use a SAVEPOINT
+            :meth:`.Connection.begin_nested` - use a SAVEPOINT
 
-        :meth:`.Connection.begin_twophase` - use a two phase /XID transaction
+            :meth:`.Connection.begin_twophase` - use a two phase /XID transaction
 
-        :meth:`.Engine.begin` - context manager available from
-        :class:`.Engine`.
+            :meth:`.Engine.begin` - context manager available from
+            :class:`.Engine`
 
         """
         if self.__branch_from:
@@ -616,8 +616,12 @@ class Connection(Connectable):
         still controls the overall ``commit`` or ``rollback`` of the
         transaction of a whole.
 
-        See also :meth:`.Connection.begin`,
-        :meth:`.Connection.begin_twophase`.
+        .. seealso::
+
+            :meth:`.Connection.begin`
+
+            :meth:`.Connection.begin_twophase`
+
         """
         if self.__branch_from:
             return self.__branch_from.begin_nested()
@@ -640,8 +644,11 @@ class Connection(Connectable):
         :param xid: the two phase transaction id.  If not supplied, a
           random id will be generated.
 
-        See also :meth:`.Connection.begin`,
-        :meth:`.Connection.begin_twophase`.
+        .. seealso::
+
+            :meth:`.Connection.begin`
+
+            :meth:`.Connection.begin_twophase`
 
         """
 
@@ -1497,7 +1504,7 @@ class Connection(Connectable):
                with engine.begin() as conn:
                    conn.execute("some statement", {'x':5, 'y':10})
 
-        See also:
+        .. seealso::
 
             :meth:`.Engine.begin` - engine-level transactional
             context
@@ -1578,8 +1585,13 @@ class Transaction(object):
 
     The Transaction object is **not** threadsafe.
 
-    See also:  :meth:`.Connection.begin`, :meth:`.Connection.begin_twophase`,
-    :meth:`.Connection.begin_nested`.
+    .. seealso::
+
+        :meth:`.Connection.begin`
+
+        :meth:`.Connection.begin_twophase`
+
+        :meth:`.Connection.begin_nested`
 
     .. index::
       single: thread safety; Transaction
@@ -1730,11 +1742,11 @@ class Engine(Connectable, log.Identified):
     An :class:`.Engine` object is instantiated publicly using the
     :func:`~sqlalchemy.create_engine` function.
 
-    See also:
+    .. seealso::
 
-    :doc:`/core/engines`
+        :doc:`/core/engines`
 
-    :ref:`connections_toplevel`
+        :ref:`connections_toplevel`
 
     """
 
@@ -2009,7 +2021,7 @@ class Engine(Connectable, log.Identified):
                with engine.begin() as conn:
                    conn.execute("some statement", {'x':5, 'y':10})
 
-        See also:
+        .. seealso::
 
             :meth:`.Engine.begin` - engine-level transactional
             context
index cd7db411073307ead508992eb5a75ae459876126..446681cbe801a2ca4913d7740014716c4f4e137d 100644 (file)
@@ -77,8 +77,7 @@ class DDLEvents(event.Events):
     The above :class:`.DDL` object will also be associated with the
     :class:`.Table` object represented by ``new_table``.
 
-
-    See also:
+    .. seealso::
 
         :ref:`event_toplevel`
 
@@ -652,9 +651,9 @@ class ConnectionEvents(event.Events):
         :param multiparams: Multiple parameter sets, a list of dictionaries.
         :param params: Single parameter set, a single dictionary.
 
-        See also:
+        .. seealso::
 
-        :meth:`.before_cursor_execute`
+            :meth:`.before_cursor_execute`
 
         """
 
@@ -704,11 +703,11 @@ class ConnectionEvents(event.Events):
         :param executemany: boolean, if ``True``, this is an ``executemany()``
          call, if ``False``, this is an ``execute()`` call.
 
-        See also:
+        .. seealso::
 
-        :meth:`.before_execute`
+            :meth:`.before_execute`
 
-        :meth:`.after_cursor_execute`
+            :meth:`.after_cursor_execute`
 
         """
 
index 77e4a4366a585a0845b893f967d91cac61c9ef3b..fa56b50d3b316032422c163c6274db00ef1aa689 100644 (file)
@@ -388,15 +388,15 @@ class CompositeProperty(DescriptorProperty):
         See the example in :ref:`composite_operations` for an overview
         of usage , as well as the documentation for :class:`.PropComparator`.
 
-        See also:
+        .. seealso::
 
-        :class:`.PropComparator`
+            :class:`.PropComparator`
 
-        :class:`.ColumnOperators`
+            :class:`.ColumnOperators`
 
-        :ref:`types_operators`
+            :ref:`types_operators`
 
-        :attr:`.TypeEngine.comparator_factory`
+            :attr:`.TypeEngine.comparator_factory`
 
         """
 
index 712366035111ec9b7009d1a822f083c33d0c27c7..2dd9d3650ed65315b7f3ed86c8318a9955dd1782 100644 (file)
@@ -316,19 +316,19 @@ class PropComparator(operators.ColumnOperators):
     :attr:`.TypeEngine.comparator_factory` attribute.  See
     :ref:`types_operators` for more detail.
 
-    See also:
+    .. seealso::
 
-    :class:`.ColumnProperty.Comparator`
+        :class:`.ColumnProperty.Comparator`
 
-    :class:`.RelationshipProperty.Comparator`
+        :class:`.RelationshipProperty.Comparator`
 
-    :class:`.CompositeProperty.Comparator`
+        :class:`.CompositeProperty.Comparator`
 
-    :class:`.ColumnOperators`
+        :class:`.ColumnOperators`
 
-    :ref:`types_operators`
+        :ref:`types_operators`
 
-    :attr:`.TypeEngine.comparator_factory`
+        :attr:`.TypeEngine.comparator_factory`
 
     """
 
index 8820f6a8e8ec0ebdb457b18d7bb6652270d13a23..3cde8484f208513122009c341dbdf3f6340fc4a2 100644 (file)
@@ -226,15 +226,15 @@ class ColumnProperty(StrategizedProperty):
         See the documentation for :class:`.PropComparator` for a brief
         overview.
 
-        See also:
+        .. seealso::
 
-        :class:`.PropComparator`
+            :class:`.PropComparator`
 
-        :class:`.ColumnOperators`
+            :class:`.ColumnOperators`
 
-        :ref:`types_operators`
+            :ref:`types_operators`
 
-        :attr:`.TypeEngine.comparator_factory`
+            :attr:`.TypeEngine.comparator_factory`
 
         """
 
index 144cbc0eb00616e567bea3c8fae9acf6f5da51de..efe326dc5f5aa242aefaa28c2979f83477af7bd9 100644 (file)
@@ -78,9 +78,9 @@ class RelationshipProperty(StrategizedProperty):
 
     Public constructor is the :func:`.orm.relationship` function.
 
-    See also:
+    .. seealso::
 
-    :ref:`relationship_config_toplevel`
+        :ref:`relationship_config_toplevel`
 
     """
 
@@ -867,17 +867,17 @@ class RelationshipProperty(StrategizedProperty):
         See the documentation for :class:`.PropComparator` for a brief
         overview of ORM level operator definition.
 
-        See also:
+        .. seealso::
 
-        :class:`.PropComparator`
+            :class:`.PropComparator`
 
-        :class:`.ColumnProperty.Comparator`
+            :class:`.ColumnProperty.Comparator`
 
-        :class:`.ColumnOperators`
+            :class:`.ColumnOperators`
 
-        :ref:`types_operators`
+            :ref:`types_operators`
 
-        :attr:`.TypeEngine.comparator_factory`
+            :attr:`.TypeEngine.comparator_factory`
 
         """
 
index af7db9b3172bf94ffd0d7f56843a791be7a6cd15..05d03bfd89fde2fbde00d4f278a34c0558eb23f8 100644 (file)
@@ -377,7 +377,9 @@ class Pool(log.Identified):
         remaining open, as it only affects connections that are
         idle in the pool.
 
-        See also the :meth:`Pool.recreate` method.
+        .. seealso::
+
+            :meth:`Pool.recreate`
 
         """
 
index 6e63eb285b9e783416083f3cfbfa46ac518d5a10..b5512ead10b77920a8ff77a0f7781573089a56a4 100644 (file)
@@ -257,15 +257,15 @@ class ColumnOperators(Operators):
     so that the ``==`` operation above is replaced by a clause
     construct.
 
-    See also:
+    .. seealso::
 
-    :ref:`types_operators`
+        :ref:`types_operators`
 
-    :attr:`.TypeEngine.comparator_factory`
+        :attr:`.TypeEngine.comparator_factory`
 
-    :class:`.ColumnOperators`
+        :class:`.ColumnOperators`
 
-    :class:`.PropComparator`
+        :class:`.PropComparator`
 
     """
 
index b2b97d690a388fcfd62db715114ab4bdd03dafb6..24796b47409058ba265e46c349fa88140b5d8472 100644 (file)
@@ -343,7 +343,7 @@ class Unicode(String):
     unicode.  The recipe at :ref:`coerce_to_unicode` illustrates
     how this is done.
 
-    See also:
+    .. seealso::
 
         :class:`.UnicodeText` - unlengthed textual counterpart
         to :class:`.Unicode`.
index e6fba2b152c0d19905aea7ecce604ef72f64b7c0..5404c8de6eb51ce39c724581284ce4fc5d6f68b1 100644 (file)
@@ -292,9 +292,9 @@ class TypeEngine(Visitable):
         The method is evaluated at statement compile time, as opposed
         to statement construction time.
 
-        See also:
+        .. seealso::
 
-        :ref:`types_sql_value_processing`
+            :ref:`types_sql_value_processing`
 
         """
 
@@ -331,9 +331,9 @@ class TypeEngine(Visitable):
         may be used in an executemany() call against an arbitrary number
         of bound parameter sets.
 
-        See also:
+        .. seealso::
 
-        :ref:`types_sql_value_processing`
+            :ref:`types_sql_value_processing`
 
         """
         return None