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/orm/query.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/orm/query.py')
-rw-r--r-- | lib/sqlalchemy/orm/query.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index 534985084..dcfbf3b32 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -696,7 +696,7 @@ class Query(object): @_generative() def populate_existing(self): - """Return a :class:`Query` that will expire and refresh all instances + """Return a :class:`.Query` that will expire and refresh all instances as they are loaded, or reused from the current :class:`.Session`. :meth:`.populate_existing` does not improve behavior when @@ -900,12 +900,12 @@ class Query(object): @_generative() def with_hint(self, selectable, text, dialect_name='*'): """Add an indexing hint for the given entity or selectable to - this :class:`Query`. + this :class:`.Query`. Functionality is passed straight through to :meth:`~sqlalchemy.sql.expression.Select.with_hint`, with the addition that ``selectable`` can be a - :class:`Table`, :class:`Alias`, or ORM entity / mapped class + :class:`.Table`, :class:`.Alias`, or ORM entity / mapped class /etc. """ mapper, selectable, is_aliased_class = _entity_info(selectable) @@ -1755,7 +1755,7 @@ class Query(object): @property def column_descriptions(self): """Return metadata about the columns which would be - returned by this :class:`Query`. + returned by this :class:`.Query`. Format is a list of dictionaries:: |