]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Fix as many RST parse warnings as possible.
authorMike Bayer <mike_mp@zzzcomputing.com>
Fri, 3 Nov 2017 18:45:18 +0000 (14:45 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Fri, 3 Nov 2017 18:47:52 +0000 (14:47 -0400)
Still a few I can't get.   Also 0.9 is EOL so hide the
unreleased notes.

Change-Id: If0e44d4a0b3e78e211f32d5c33b51b1a007c9c69
(cherry picked from commit 75bdcd096f12012bf45cffebd597c33b501c2ef2)

doc/build/changelog/changelog_09.rst
doc/build/changelog/changelog_11.rst
lib/sqlalchemy/dialects/mssql/__init__.py
lib/sqlalchemy/dialects/postgresql/dml.py
lib/sqlalchemy/dialects/postgresql/psycopg2.py
lib/sqlalchemy/dialects/sqlite/base.py
lib/sqlalchemy/orm/session.py

index 159c5acfe96cfda75cf44de2af0d6ccbc0754537..f1f2901643684e83b7bd766ed27e18e72d384d34 100644 (file)
@@ -1,4 +1,3 @@
-
 =============
 0.9 Changelog
 =============
@@ -11,7 +10,7 @@
     .. include:: changelog_07.rst
         :start-line: 5
 
-.. changelog::
+.. _unreleased_changelog::
     :version: 0.9.11
 
     .. change::
 
             :ref:`relationship_custom_operator`
 
-
     .. change::
         :tags: bug, sqlite
 
index 31dafca335e2578b170eb8745fc009b545fdec4b..a524678c6255811d266fd386f23c24529cd37d78 100644 (file)
@@ -1,5 +1,3 @@
-
-
 =============
 1.1 Changelog
 =============
@@ -18,6 +16,7 @@
     .. include:: changelog_07.rst
         :start-line: 5
 
+
 .. changelog::
     :version: 1.1.15
     :include_notes_from: unreleased_11
         processing, as normally takes effect to handle both user-defined
         type level conversions as well as dialect-required conversions, such
         as those required for JSON datatypes.   Additionally, clarified that
-        the keys in the set_ dictionary should match the "key" of the column,
-        if distinct from the column name.  A warning is emitted
+        the keys in the ``set_`` dictionary should match the "key" of the
+        column, if distinct from the column name.  A warning is emitted
         for remaining column names that don't match column keys; for
         compatibility reasons, these are emitted as they were previously.
 
         :tickets: 3878
 
         Fixed 1.1 regression where "import *" would not work for
-        sqlalchemy.sql.expression, due to mis-spelled "any_" and "all_"
+        sqlalchemy.sql.expression, due to mis-spelled ``any_`` and ``all_``
         functions.
 
     .. change:: 3880
index 6b70df3a853fec4bf98bb3368bee3959bd309359..68aa3cfc3e42eb45bdbaa5e9e8f85afae659765d 100644 (file)
@@ -15,7 +15,7 @@ from sqlalchemy.dialects.mssql.base import \
     NCHAR, TEXT, NTEXT, DECIMAL, NUMERIC, FLOAT, DATETIME,\
     DATETIME2, DATETIMEOFFSET, DATE, TIME, SMALLDATETIME, \
     BINARY, VARBINARY, BIT, REAL, IMAGE, TIMESTAMP,\
-    MONEY, SMALLMONEY, UNIQUEIDENTIFIER, SQL_VARIANT, dialect
+    MONEY, SMALLMONEY, UNIQUEIDENTIFIER, SQL_VARIANT, XML, dialect
 
 
 __all__ = (
@@ -23,5 +23,5 @@ __all__ = (
     'NCHAR', 'TEXT', 'NTEXT', 'DECIMAL', 'NUMERIC', 'FLOAT', 'DATETIME',
     'DATETIME2', 'DATETIMEOFFSET', 'DATE', 'TIME', 'SMALLDATETIME',
     'BINARY', 'VARBINARY', 'BIT', 'REAL', 'IMAGE', 'TIMESTAMP',
-    'MONEY', 'SMALLMONEY', 'UNIQUEIDENTIFIER', 'SQL_VARIANT', 'dialect'
+    'MONEY', 'SMALLMONEY', 'UNIQUEIDENTIFIER', 'SQL_VARIANT', 'XML', 'dialect'
 )
index bfdfbfa36498ef37146b54e59c212840ae28e889..503e2902462d03ac26c29f3a43b4f4462bd83687 100644 (file)
@@ -54,40 +54,41 @@ class Insert(StandardInsert):
         required, but only one of these can be specified.
 
         :param constraint:
-        The name of a unique or exclusion constraint on the table,
-        or the constraint object itself if it has a .name attribute.
+         The name of a unique or exclusion constraint on the table,
+         or the constraint object itself if it has a .name attribute.
 
         :param index_elements:
-        A sequence consisting of string column names, :class:`.Column`
-        objects, or other column expression objects that will be used
-        to infer a target index.
+         A sequence consisting of string column names, :class:`.Column`
+         objects, or other column expression objects that will be used
+         to infer a target index.
 
         :param index_where:
-        Additional WHERE criterion that can be used to infer a
-        conditional target index.
+         Additional WHERE criterion that can be used to infer a
+         conditional target index.
 
         :param set_:
-        Required argument. A dictionary or other mapping object
-        with column names as keys and expressions or literals as values,
-        specifying the ``SET`` actions to take.
-        If the target :class:`.Column` specifies a ".key" attribute distinct
-        from the column name, that key should be used.
-
-        .. warning:: This dictionary does **not** take into account
-           Python-specified default UPDATE values or generation functions,
-           e.g. those specified using :paramref:`.Column.onupdate`.
-           These values will not be exercised for an ON CONFLICT style of
-           UPDATE, unless they are manually specified in the
-           :paramref:`.Insert.on_conflict_do_update.set_` dictionary.
+         Required argument. A dictionary or other mapping object
+         with column names as keys and expressions or literals as values,
+         specifying the ``SET`` actions to take.
+         If the target :class:`.Column` specifies a ".key" attribute distinct
+         from the column name, that key should be used.
+
+         .. warning:: This dictionary does **not** take into account
+            Python-specified default UPDATE values or generation functions,
+            e.g. those specified using :paramref:`.Column.onupdate`.
+            These values will not be exercised for an ON CONFLICT style of
+            UPDATE, unless they are manually specified in the
+            :paramref:`.Insert.on_conflict_do_update.set_` dictionary.
 
         :param where:
-        Optional argument. If present, can be a literal SQL
-        string or an acceptable expression for a ``WHERE`` clause
-        that restricts the rows affected by ``DO UPDATE SET``. Rows
-        not meeting the ``WHERE`` condition will not be updated
-        (effectively a ``DO NOTHING`` for those rows).
+         Optional argument. If present, can be a literal SQL
+         string or an acceptable expression for a ``WHERE`` clause
+         that restricts the rows affected by ``DO UPDATE SET``. Rows
+         not meeting the ``WHERE`` condition will not be updated
+         (effectively a ``DO NOTHING`` for those rows).
+
+         .. versionadded:: 1.1
 
-        .. versionadded:: 1.1
 
         .. seealso::
 
@@ -109,19 +110,19 @@ class Insert(StandardInsert):
         are optional, but only one of these can be specified.
 
         :param constraint:
-        The name of a unique or exclusion constraint on the table,
-        or the constraint object itself if it has a .name attribute.
+         The name of a unique or exclusion constraint on the table,
+         or the constraint object itself if it has a .name attribute.
 
         :param index_elements:
-        A sequence consisting of string column names, :class:`.Column`
-        objects, or other column expression objects that will be used
-        to infer a target index.
+         A sequence consisting of string column names, :class:`.Column`
+         objects, or other column expression objects that will be used
+         to infer a target index.
 
         :param index_where:
-        Additional WHERE criterion that can be used to infer a
-        conditional target index.
+         Additional WHERE criterion that can be used to infer a
+         conditional target index.
 
-        .. versionadded:: 1.1
+         .. versionadded:: 1.1
 
         .. seealso::
 
index 50328143e37183bc458418c936a07ec36636a733..290ad4146d6e26109886b32f7398b86aab911cd4 100644 (file)
@@ -5,12 +5,11 @@
 # This module is part of SQLAlchemy and is released under
 # the MIT License: http://www.opensource.org/licenses/mit-license.php
 
-"""
+r"""
 .. dialect:: postgresql+psycopg2
     :name: psycopg2
     :dbapi: psycopg2
-    :connectstring: postgresql+psycopg2://user:password@host:port/dbname\
-[?key=value&key=value...]
+    :connectstring: postgresql+psycopg2://user:password@host:port/dbname[?key=value&key=value...]
     :url: http://pypi.python.org/pypi/psycopg2/
 
 psycopg2 Connect Arguments
@@ -31,6 +30,7 @@ psycopg2-specific keyword arguments which are accepted by
   Note that the :paramref:`.Connection.execution_options.stream_results`
   execution option is a more targeted
   way of enabling this mode on a per-execution basis.
+
 * ``use_native_unicode``: Enable the usage of Psycopg2 "native unicode" mode
   per connection.  True by default.
 
@@ -70,10 +70,9 @@ using ``host`` as an additional keyword argument::
     create_engine("postgresql+psycopg2://user:password@/dbname?\
 host=/var/lib/postgresql")
 
-See also:
+.. seealso::
 
-`PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/\
-libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_
+    `PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_
 
 .. _psycopg2_execution_options:
 
index d8ce7f394caa46f9ec38e1bf044b375eae5672f7..a052fce4e4302f91be8a6ad282dba095b2ab2190 100644 (file)
@@ -531,8 +531,7 @@ class DATETIME(_DateTimeMixin, sqltypes.DateTime):
 
     The default string storage format is::
 
-        "%(year)04d-%(month)02d-%(day)02d %(hour)02d:%(min)02d:\
-%(second)02d.%(microsecond)06d"
+        "%(year)04d-%(month)02d-%(day)02d %(hour)02d:%(min)02d:%(second)02d.%(microsecond)06d"
 
     e.g.::
 
@@ -558,6 +557,7 @@ class DATETIME(_DateTimeMixin, sqltypes.DateTime):
      Otherwise, if positional groups are used, the datetime() constructor
      is called with positional arguments via
      ``*map(int, match_obj.groups(0))``.
+
     """
 
     _storage_format = (
index 87f73e71b9ca5a205e207240901db6b10da769e8..96944f47896d84bbaba9af5f7a16e6d9f981b87c 100644 (file)
@@ -179,25 +179,25 @@ class SessionTransaction(object):
 
     .. seealso::
 
-    :meth:`.Session.rollback`
+        :meth:`.Session.rollback`
 
-    :meth:`.Session.commit`
+        :meth:`.Session.commit`
 
-    :meth:`.Session.begin`
+        :meth:`.Session.begin`
 
-    :meth:`.Session.begin_nested`
+        :meth:`.Session.begin_nested`
 
-    :attr:`.Session.is_active`
+        :attr:`.Session.is_active`
 
-    :meth:`.SessionEvents.after_transaction_create`
+        :meth:`.SessionEvents.after_transaction_create`
 
-    :meth:`.SessionEvents.after_transaction_end`
+        :meth:`.SessionEvents.after_transaction_end`
 
-    :meth:`.SessionEvents.after_commit`
+        :meth:`.SessionEvents.after_commit`
 
-    :meth:`.SessionEvents.after_rollback`
+        :meth:`.SessionEvents.after_rollback`
 
-    :meth:`.SessionEvents.after_soft_rollback`
+        :meth:`.SessionEvents.after_soft_rollback`
 
     """