summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2012-06-08 15:55:08 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2012-06-08 15:55:08 -0400
commit27f7c595d216c8b1d87e5a3648ada09f684542d9 (patch)
treede07aa5ef8c3c012a322ab076897a62a07e11fe4 /lib/sqlalchemy/engine
parent97e97324d67056972b1f959ce41d0be441cec992 (diff)
downloadsqlalchemy-27f7c595d216c8b1d87e5a3648ada09f684542d9.tar.gz
Add some `Sphinx` paragraph level versions informations markups,
such as ``.. versionadded::``, ``.. versionchanged::`` and ``.. deprecated::``.
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/__init__.py12
-rw-r--r--lib/sqlalchemy/engine/base.py8
2 files changed, 13 insertions, 7 deletions
diff --git a/lib/sqlalchemy/engine/__init__.py b/lib/sqlalchemy/engine/__init__.py
index 3fa594216..0f8c09850 100644
--- a/lib/sqlalchemy/engine/__init__.py
+++ b/lib/sqlalchemy/engine/__init__.py
@@ -145,9 +145,11 @@ def create_engine(*args, **kwargs):
:param case_sensitive=True: if False, result column names
will match in a case-insensitive fashion, that is,
- ``row['SomeColumn']``. By default, result row names
- match case-sensitively as of version 0.8. In version
- 0.7 and prior, all matches were case-insensitive.
+ ``row['SomeColumn']``.
+
+ .. versionchanged:: 0.8
+ By default, result row names match case-sensitively.
+ In version 0.7 and prior, all matches were case-insensitive.
:param connect_args: a dictionary of options which will be
passed directly to the DBAPI's ``connect()`` method as
@@ -316,7 +318,9 @@ def create_engine(*args, **kwargs):
behavior of the pool, which is whether ``rollback()``,
``commit()``, or nothing is called upon connections
being returned to the pool. See the docstring for
- ``reset_on_return`` at :class:`.Pool`. (new as of 0.7.6)
+ ``reset_on_return`` at :class:`.Pool`.
+
+ .. versionadded:: 0.7.6
:param pool_timeout=30: number of seconds to wait before giving
up on getting a connection from the pool. This is only used
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index a631f5c32..f68c31b97 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -998,8 +998,10 @@ class Connection(Connectable):
containing percent signs (and possibly other characters)
that is neutral regarding whether it's executed by the DBAPI
or piped into a script that's later invoked by
- command line tools. New in 0.7.6.
-
+ command line tools.
+
+ .. versionadded:: 0.7.6
+
:param stream_results: Available on: Connection, statement.
Indicate to the dialect that results should be
"streamed" and not pre-buffered, if possible. This is a limitation
@@ -2346,7 +2348,7 @@ class Engine(Connectable, log.Identified):
close the :class:`.Connection` when that :class:`.ResultProxy`
has exhausted all result rows.
- New in 0.7.6.
+ .. versionadded:: 0.7.6
See also: