diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-03-17 21:13:14 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-03-17 21:13:14 -0400 |
| commit | 2136054ca86284bbfabc9f39787aae88667acbcd (patch) | |
| tree | 67c93be37219b2c24f26b14a11eb1ccd71aadd9e /lib/sqlalchemy/interfaces.py | |
| parent | 0e9f0b5c79e7737125a8e304d9ba432114cec6e5 (diff) | |
| download | sqlalchemy-2136054ca86284bbfabc9f39787aae88667acbcd.tar.gz | |
- some doc reorg
- change engine.Connection to _connection_cls so sphinx doesn't get upset
- globally add "." to all :class:`Foo`
- start naming sections that are mostly docstrings "API Documentation - blah blah"
- move some ad-hoc docstrings into "API" sections, there is some inconsistency here
and it may be that we just have to leave it that way
- add "internals" rsts to core, orm, I'm not super thrilled how these look but they are
targeted by some of the public api docs, users typically become aware of these anyway
Diffstat (limited to 'lib/sqlalchemy/interfaces.py')
| -rw-r--r-- | lib/sqlalchemy/interfaces.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/sqlalchemy/interfaces.py b/lib/sqlalchemy/interfaces.py index 07e574ba5..d1e3fa6b2 100644 --- a/lib/sqlalchemy/interfaces.py +++ b/lib/sqlalchemy/interfaces.py @@ -15,9 +15,9 @@ event system. from sqlalchemy import event, util class PoolListener(object): - """Hooks into the lifecycle of connections in a :class:`Pool`. + """Hooks into the lifecycle of connections in a :class:`.Pool`. - .. note:: :class:`PoolListener` is deprecated. Please + .. note:: :class:`.PoolListener` is deprecated. Please refer to :class:`.PoolEvents`. Usage:: @@ -71,7 +71,7 @@ class PoolListener(object): @classmethod def _adapt_listener(cls, self, listener): - """Adapt a :class:`PoolListener` to individual + """Adapt a :class:`.PoolListener` to individual :class:`event.Dispatch` events. """ @@ -149,8 +149,8 @@ class PoolListener(object): class ConnectionProxy(object): """Allows interception of statement execution by Connections. - .. note:: :class:`ConnectionProxy` is deprecated. Please - refer to :class:`.EngineEvents`. + .. note:: :class:`.ConnectionProxy` is deprecated. Please + refer to :class:`.ConnectionEvents`. Either or both of the ``execute()`` and ``cursor_execute()`` may be implemented to intercept compiled statement and |