From: Michael Trier Date: Sun, 5 Oct 2008 03:30:58 +0000 (+0000) Subject: Corrected docs for declarative synonym incorrectly referring to instruments instead... X-Git-Tag: rel_0_5rc2~10 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f0a40280fd2efa2708d1cd09ca074779aa76649e;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Corrected docs for declarative synonym incorrectly referring to instruments instead of descriptor. --- diff --git a/doc/build/content/plugins.txt b/doc/build/content/plugins.txt index 80e6c9fbb3..d896ff33ca 100644 --- a/doc/build/content/plugins.txt +++ b/doc/build/content/plugins.txt @@ -123,7 +123,7 @@ class after the fact: User.addresses = relation(Address, primaryjoin=Address.user_id==User.id) Synonyms are one area where `declarative` needs to slightly change the usual SQLAlchemy configurational syntax. To define a -getter/setter which proxies to an underlying attribute, use `synonym` with the `instruments` argument: +getter/setter which proxies to an underlying attribute, use `synonym` with the `descriptor` argument: {python} class MyClass(Base): @@ -133,9 +133,9 @@ getter/setter which proxies to an underlying attribute, use `synonym` with the ` def _get_attr(self): return self._some_attr - def _set_attr(self, attr) + def _set_attr(self, attr): self._some_attr = attr - attr = synonym('_attr', instruments=property(_get_attr, _set_attr)) + attr = synonym('_attr', descriptor=property(_get_attr, _set_attr)) The above synonym is then usable as an instance attribute as well as a class-level expression construct: