diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2009-01-03 22:40:58 +0000 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2009-01-03 22:40:58 +0000 |
| commit | 54c00bb127feb5388f868d32116d3aa6980e39fb (patch) | |
| tree | 72142ea050f8a402cb6712bf594612f39f64d606 /lib/sqlalchemy/sql/util.py | |
| parent | 653191d913b980964d45b4ef92ed6a0b5d95af91 (diff) | |
| download | sqlalchemy-54c00bb127feb5388f868d32116d3aa6980e39fb.tar.gz | |
docstrings for the hated fold_equivalents argument/function
Diffstat (limited to 'lib/sqlalchemy/sql/util.py')
| -rw-r--r-- | lib/sqlalchemy/sql/util.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/sqlalchemy/sql/util.py b/lib/sqlalchemy/sql/util.py index a808c508d..b8ceabb74 100644 --- a/lib/sqlalchemy/sql/util.py +++ b/lib/sqlalchemy/sql/util.py @@ -346,7 +346,10 @@ def criterion_as_pairs(expression, consider_as_foreign_keys=None, consider_as_re return pairs def folded_equivalents(join, equivs=None): - """Returns the column list of the given Join with all equivalently-named, + """Return a list of uniquely named columns. + + The column list of the given Join will be narrowed + down to a list of all equivalently-named, equated columns folded into one column, where 'equated' means they are equated to each other in the ON clause of this join. |