openstack/deb-python-sqlalchemy-utils
Code Issues Proposed changes

Fix doc blocks

Browse Source
This commit is contained in:
Konsta Vesterinen
2014-05-07 15:45:42 +03:00
parent 823ad79d9b
commit f7652ea2d2
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
sqlalchemy_utils/functions/orm.py
View File

@@ -33,8 +33,8 @@ def dependent_objects(obj, foreign_keys=None):
dependent_objects(user) dependent_objects(user)
If you expect an object to have lots of dependent_objects it might be good to If you expect an object to have lots of dependent_objects it might be good
limit the results:: to limit the results::
dependent_objects(user).limit(5) dependent_objects(user).limit(5)
@@ -79,9 +79,9 @@ def dependent_objects(obj, foreign_keys=None):
:param obj: SQLAlchemy declarative model object :param obj: SQLAlchemy declarative model object
:param foreign_keys: :param foreign_keys:
A sequence of foreign keys to use for searching the dependent_objects for A sequence of foreign keys to use for searching the dependent_objects
given object. By default this is None, indicating that all foreign keys for given object. By default this is None, indicating that all foreign
referencing the object will be used. keys referencing the object will be used.
.. note:: .. note::
This function does not support exotic mappers that use multiple tables This function does not support exotic mappers that use multiple tables
@@ -412,7 +412,9 @@ def query_entities(query):
query_entities(query) # <Category> query_entities(query) # <Category>
This function also supports queries with joins: This function also supports queries with joins.
::
query = session.query(Category).join(Article) query = session.query(Category).join(Article)