]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Further refine map_column verbiage
authorMike Bayer <mike_mp@zzzcomputing.com>
Thu, 25 Jan 2018 14:17:41 +0000 (09:17 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 25 Jan 2018 14:18:14 +0000 (09:18 -0500)
The verbiage here continues to be misleading as it implies that
a MapperProperty already exists for the Column when this is not
the case.

Change-Id: Iaa6990dc9693d47d50b15c4815c3c7f6f34d8577
(cherry picked from commit bc9cdd5de0781b93f9cf581f1c5e0d96179ad12e)

lib/sqlalchemy/orm/descriptor_props.py

index 449ae6e6a513dd3de0b3314b1009043850b48cf5..bc9c7f97ec617bd2f7395aabc0744ca03842ef08 100644 (file)
@@ -525,11 +525,16 @@ class SynonymProperty(DescriptorProperty):
 
         :param map_column: **For classical mappings and mappings against
           an existing Table object only**.  if ``True``, the :func:`.synonym`
-          construct will locate the existing named :class:`.MapperProperty`
-          based on the attribute name of this :func:`.synonym`, and assign it
-          to a new attribute linked to the name of this :func:`.synonym`.
-          This is intended to be used with the :paramref:`.synonym.descriptor`
-          parameter::
+          construct will locate the :class:`.Column` object upon the mapped
+          table that would normally be associated with the attribute name of
+          this synonym, and produce a new :class:`.ColumnProperty` that instead
+          maps this :class:`.Column` to the alternate name given as the "name"
+          argument of the synonym; in this way, the usual step of redefining
+          the mapping of the :class:`.Column` to be under a different name is
+          unnecessary. This is usually intended to be used when a
+          :class:`.Column` is to be replaced with an attribute that also uses a
+          descriptor, that is, in conjunction with the
+          :paramref:`.synonym.descriptor` parameter::
 
             my_table = Table(
                 "my_table", metadata,