summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/ext
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2011-12-25 17:34:24 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2011-12-25 17:34:24 -0500
commit68f6951019dce746a0d093ee597e89d68f4d8fc0 (patch)
tree24c6c415aacf75e2a24215626215f7853e0b9469 /lib/sqlalchemy/ext
parent6ed0d7e3339dd14daad612f9ac6dd2f5e90ef517 (diff)
downloadsqlalchemy-68f6951019dce746a0d093ee597e89d68f4d8fc0.tar.gz
fix a whole bunch of note:: / warning:: that were inline,
no longer compatible with docutils 0.8
Diffstat (limited to 'lib/sqlalchemy/ext')
-rwxr-xr-xlib/sqlalchemy/ext/declarative.py8
-rw-r--r--lib/sqlalchemy/ext/mutable.py12
-rw-r--r--lib/sqlalchemy/ext/orderinglist.py4
-rw-r--r--lib/sqlalchemy/ext/sqlsoup.py10
4 files changed, 24 insertions, 10 deletions
diff --git a/lib/sqlalchemy/ext/declarative.py b/lib/sqlalchemy/ext/declarative.py
index ffbdfaae9..91d770197 100755
--- a/lib/sqlalchemy/ext/declarative.py
+++ b/lib/sqlalchemy/ext/declarative.py
@@ -1424,9 +1424,11 @@ class declared_attr(property):
"""Mark a class-level method as representing the definition of
a mapped property or special declarative member name.
- .. note:: @declared_attr is available as
- ``sqlalchemy.util.classproperty`` for SQLAlchemy versions
- 0.6.2, 0.6.3, 0.6.4.
+ .. note::
+
+ @declared_attr is available as
+ ``sqlalchemy.util.classproperty`` for SQLAlchemy versions
+ 0.6.2, 0.6.3, 0.6.4.
@declared_attr turns the attribute into a scalar-like
property that can be invoked from the uninstantiated class.
diff --git a/lib/sqlalchemy/ext/mutable.py b/lib/sqlalchemy/ext/mutable.py
index ece7e3ad4..8f14f5197 100644
--- a/lib/sqlalchemy/ext/mutable.py
+++ b/lib/sqlalchemy/ext/mutable.py
@@ -448,7 +448,9 @@ class Mutable(MutableBase):
This is a convenience method that calls ``associate_with_attribute`` automatically.
- .. warning:: The listeners established by this method are *global*
+ .. warning::
+
+ The listeners established by this method are *global*
to all mappers, and are *not* garbage collected. Only use
:meth:`.associate_with` for types that are permanent to an application,
not with ad-hoc types else this will cause unbounded growth
@@ -488,7 +490,9 @@ class Mutable(MutableBase):
of the particular :meth:`.Mutable` subclass to establish a global
association.
- .. warning:: The listeners established by this method are *global*
+ .. warning::
+
+ The listeners established by this method are *global*
to all mappers, and are *not* garbage collected. Only use
:meth:`.as_mutable` for types that are permanent to an application,
not with ad-hoc types else this will cause unbounded growth
@@ -519,7 +523,9 @@ class MutableComposite(MutableBase):
See the example in :ref:`mutable_composites` for usage information.
- .. warning:: The listeners established by the :class:`.MutableComposite`
+ .. warning::
+
+ The listeners established by the :class:`.MutableComposite`
class are *global* to all mappers, and are *not* garbage collected. Only use
:class:`.MutableComposite` for types that are permanent to an application,
not with ad-hoc types else this will cause unbounded growth
diff --git a/lib/sqlalchemy/ext/orderinglist.py b/lib/sqlalchemy/ext/orderinglist.py
index ce63b88ea..ba505eb7b 100644
--- a/lib/sqlalchemy/ext/orderinglist.py
+++ b/lib/sqlalchemy/ext/orderinglist.py
@@ -73,7 +73,9 @@ Use the ``ordering_list`` function to set up the ``collection_class`` on relatio
(as in the mapper example above). This implementation depends on the list
starting in the proper order, so be SURE to put an order_by on your relationship.
-.. warning:: ``ordering_list`` only provides limited functionality when a primary
+.. warning::
+
+ ``ordering_list`` only provides limited functionality when a primary
key column or unique column is the target of the sort. Since changing the order of
entries often means that two rows must trade values, this is not possible when
the value is constrained by a primary key or unique constraint, since one of the rows
diff --git a/lib/sqlalchemy/ext/sqlsoup.py b/lib/sqlalchemy/ext/sqlsoup.py
index fe2f74137..189aa1af1 100644
--- a/lib/sqlalchemy/ext/sqlsoup.py
+++ b/lib/sqlalchemy/ext/sqlsoup.py
@@ -6,7 +6,9 @@
"""
-.. note:: SQLSoup will no longer be included with SQLAlchemy as of 0.8.
+.. note::
+
+ SQLSoup will no longer be included with SQLAlchemy as of 0.8.
Look for a third party project replicating its functionality soon.
@@ -250,8 +252,10 @@ Advanced Use
Sessions, Transations and Application Integration
-------------------------------------------------
-**Note:** please read and understand this section thoroughly
-before using SqlSoup in any web application.
+.. note::
+
+ Please read and understand this section thoroughly
+ before using SqlSoup in any web application.
SqlSoup uses a ScopedSession to provide thread-local sessions.
You can get a reference to the current one like this::