From: Jason Kirtland Date: Tue, 18 Mar 2008 03:05:34 +0000 (+0000) Subject: - reST fixes X-Git-Tag: rel_0_4_5~79 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=67fc7abe6d85bb1f6b500b47cb507082b97365d7;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git - reST fixes --- diff --git a/lib/sqlalchemy/ext/declarative.py b/lib/sqlalchemy/ext/declarative.py index 7f30a7374e..77c6a7684e 100644 --- a/lib/sqlalchemy/ext/declarative.py +++ b/lib/sqlalchemy/ext/declarative.py @@ -246,7 +246,7 @@ def synonym_for(name, map_column=False): A decorator version of [sqlalchemy.orm#synonym()]. The function being decoratred is the 'instrument', otherwise passes its arguments through - to synonym(). + to synonym():: @synonym_for('col') @property @@ -268,7 +268,7 @@ def comparable_using(comparator_factory): """Decorator, allow a Python @property to be used in query criteria. A decorator front end to [sqlalchemy.orm#comparable_property()], passes - throgh the comparator_factory and the function being decorated. + throgh the comparator_factory and the function being decorated:: @comparable_using(MyComparatorType) @property diff --git a/lib/sqlalchemy/orm/__init__.py b/lib/sqlalchemy/orm/__init__.py index 1384bdccf6..c30e96b013 100644 --- a/lib/sqlalchemy/orm/__init__.py +++ b/lib/sqlalchemy/orm/__init__.py @@ -598,7 +598,7 @@ def comparable_property(comparator_factory, descriptor=None): SQL constructs like a managed attribute. comparable_property wraps a descriptor with a proxy that directs operator overrides such as == (__eq__) to the supplied comparator but proxies everything else through - to the original descriptor. + to the original descriptor:: class MyClass(object): @property @@ -619,7 +619,6 @@ def comparable_property(comparator_factory, descriptor=None): for this property. descriptor - Optional when used in a ``properties={}`` declaration. The Python descriptor or property to layer comparison behavior on top of.