]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Fix cross references
authorVraj Mohan <r.vrajmohan@gmail.com>
Fri, 15 Nov 2013 13:32:07 +0000 (08:32 -0500)
committerVraj Mohan <r.vrajmohan@gmail.com>
Sun, 17 Nov 2013 22:37:55 +0000 (17:37 -0500)
doc/build/core/tutorial.rst
doc/build/orm/extensions/declarative.rst
doc/build/orm/extensions/mutable.rst
lib/sqlalchemy/events.py
lib/sqlalchemy/ext/declarative/__init__.py
lib/sqlalchemy/ext/declarative/api.py
lib/sqlalchemy/ext/mutable.py

index 492c294cab6a8e8123387d1656193b6ca54b413f..c2a55233d49891f7fa5bb81061da6efdf6be6d18 100644 (file)
@@ -281,7 +281,7 @@ did not specify the ``id`` column in our
 value would have been used. In either case, SQLAlchemy always knows how to get
 at a newly generated primary key value, even though the method of generating
 them is different across different databases; each database's
-:class:`~sqlalchemy.engine.base.Dialect` knows the specific steps needed to
+:class:`~sqlalchemy.engine.interfaces.Dialect` knows the specific steps needed to
 determine the correct value (or values; note that ``inserted_primary_key``
 returns a list so that it supports composite primary keys).
 
index 671e0e05b8992fc411a5afaa235f7d2d5b8cbb00..636bb451b8a31c96a092720979e834e955d95b73 100644 (file)
@@ -29,3 +29,4 @@ API Reference
 .. autoclass:: ConcreteBase
 
 .. autoclass:: DeferredReflection
+   :members:
index d2a292d905c54d3f212e6a4b9f65760508ddfdfc..14875cd3ca77f8ad810cc24b9f4c549152c378a3 100644 (file)
@@ -13,13 +13,13 @@ API Reference
 
 .. autoclass:: Mutable
     :members:
+    :inherited-members:
+    :private-members:
 
 .. autoclass:: MutableComposite
-     
     :members:
 
 .. autoclass:: MutableDict
-        
        :members:
 
 
index c0118dd9f925c238fbf5c7cc89176b4704b4184b..a7de37ef87849715df7311a008d7ed126012cb49 100644 (file)
@@ -14,7 +14,7 @@ from .sql.base import SchemaEventTarget
 class DDLEvents(event.Events):
     """
     Define event listeners for schema objects,
-    that is, :class:`.SchemaItem` and :class:`.SchemaEvent`
+    that is, :class:`.SchemaItem` and other :class:`.SchemaEventTarget`
     subclasses, including :class:`.MetaData`, :class:`.Table`,
     :class:`.Column`.
 
index b92adf02b62e40bf7cdae584c46ec0fdbde96f42..e94b27cdabe4b98570f1b3db5c91d2eb93ab4b90 100644 (file)
@@ -1238,7 +1238,7 @@ Sessions
 Note that ``declarative`` does nothing special with sessions, and is
 only intended as an easier way to configure mappers and
 :class:`~sqlalchemy.schema.Table` objects.  A typical application
-setup using :class:`~sqlalchemy.orm.scoped_session` might look like::
+setup using :class:`~sqlalchemy.orm.scoping.scoped_session` might look like::
 
     engine = create_engine('postgresql://scott:tiger@localhost/test')
     Session = scoped_session(sessionmaker(autocommit=False,
index b309a783a4adff9d4a690c8b3fbc24414c33c28b..2f84896aac16991d803dc55436ff474d8330b5cb 100644 (file)
@@ -174,16 +174,16 @@ def declarative_base(bind=None, metadata=None, mapper=None, cls=object,
     of the class.
 
     :param bind: An optional
-      :class:`~sqlalchemy.engine.base.Connectable`, will be assigned
-      the ``bind`` attribute on the :class:`~sqlalchemy.MetaData`
+      :class:`~sqlalchemy.engine.Connectable`, will be assigned
+      the ``bind`` attribute on the :class:`~sqlalchemy.schema.MetaData`
       instance.
 
     :param metadata:
-      An optional :class:`~sqlalchemy.MetaData` instance.  All
+      An optional :class:`~sqlalchemy.schema.MetaData` instance.  All
       :class:`~sqlalchemy.schema.Table` objects implicitly declared by
       subclasses of the base will share this MetaData.  A MetaData instance
       will be created if none is provided.  The
-      :class:`~sqlalchemy.MetaData` instance will be available via the
+      :class:`~sqlalchemy.schema.MetaData` instance will be available via the
       `metadata` attribute of the generated declarative base class.
 
     :param mapper:
@@ -286,7 +286,7 @@ class ConcreteBase(object):
     function automatically, against all tables mapped as a subclass
     to this class.   The function is called via the
     ``__declare_last__()`` function, which is essentially
-    a hook for the :func:`.MapperEvents.after_configured` event.
+    a hook for the :meth:`.after_configured` event.
 
     :class:`.ConcreteBase` produces a mapped
     table for the class itself.  Compare to :class:`.AbstractConcreteBase`,
@@ -341,7 +341,7 @@ class AbstractConcreteBase(ConcreteBase):
     function automatically, against all tables mapped as a subclass
     to this class.   The function is called via the
     ``__declare_last__()`` function, which is essentially
-    a hook for the :func:`.MapperEvents.after_configured` event.
+    a hook for the :meth:`.after_configured` event.
 
     :class:`.AbstractConcreteBase` does not produce a mapped
     table for the class itself.  Compare to :class:`.ConcreteBase`,
@@ -421,7 +421,7 @@ class DeferredReflection(object):
     Above, ``MyClass`` is not yet mapped.   After a series of
     classes have been defined in the above fashion, all tables
     can be reflected and mappings created using
-    :meth:`.DeferredReflection.prepare`::
+    :meth:`.prepare`::
 
         engine = create_engine("someengine://...")
         DeferredReflection.prepare(engine)
index a83a2a19f9d1d6db0435bd2753d1d5ab810251c5..37c599e1d714c39dbecf1698626fb2441ec80464 100644 (file)
@@ -182,7 +182,7 @@ callbacks. In our case, this is a good thing, since if this dictionary were
 picklable, it could lead to an excessively large pickle size for our value
 objects that are pickled by themselves outside of the context of the parent.
 The developer responsibility here is only to provide a ``__getstate__`` method
-that excludes the :meth:`~.MutableBase._parents` collection from the pickle
+that excludes the :meth:`~MutableBase._parents` collection from the pickle
 stream::
 
     class MyMutableType(Mutable):
@@ -332,7 +332,7 @@ Supporting Pickling
 
 As is the case with :class:`.Mutable`, the :class:`.MutableComposite` helper
 class uses a ``weakref.WeakKeyDictionary`` available via the
-:meth:`.MutableBase._parents` attribute which isn't picklable. If we need to
+:meth:`MutableBase._parents` attribute which isn't picklable. If we need to
 pickle instances of ``Point`` or its owning class ``Vertex``, we at least need
 to define a ``__getstate__`` that doesn't include the ``_parents`` dictionary.
 Below we define both a ``__getstate__`` and a ``__setstate__`` that package up
@@ -349,7 +349,7 @@ the minimal form of our ``Point`` class::
 
 As with :class:`.Mutable`, the :class:`.MutableComposite` augments the
 pickling process of the parent's object-relational state so that the
-:meth:`.MutableBase._parents` collection is restored to all ``Point`` objects.
+:meth:`MutableBase._parents` collection is restored to all ``Point`` objects.
 
 """
 from ..orm.attributes import flag_modified
@@ -542,7 +542,7 @@ class Mutable(MutableBase):
 
         To associate a particular mutable type with all occurrences of a
         particular type, use the :meth:`.Mutable.associate_with` classmethod
-        of the particular :meth:`.Mutable` subclass to establish a global
+        of the particular :class:`.Mutable` subclass to establish a global
         association.
 
         .. warning::