From 04a5292425f92eeb822e55b283a44bc44e7e1b35 Mon Sep 17 00:00:00 2001
From: Konsta Vesterinen <konsta.vesterinen@gmail.com>
Date: Wed, 14 May 2014 15:51:32 +0300
Subject: [PATCH] Add docs for get_mapper

---
 docs/model_helpers.rst            |  6 ++++++
 sqlalchemy_utils/functions/orm.py | 23 ++++++++++++++++++++++-
 2 files changed, 28 insertions(+), 1 deletion(-)

diff --git a/docs/model_helpers.rst b/docs/model_helpers.rst
index 55d8205..55cd91c 100644
--- a/docs/model_helpers.rst
+++ b/docs/model_helpers.rst
@@ -34,6 +34,12 @@ get_declarative_base
 .. autofunction:: get_declarative_base
 
 
+get_mapper
+^^^^^^^^^^
+
+.. autofunction:: get_mapper
+
+
 get_primary_keys
 ^^^^^^^^^^^^^^^^
 
diff --git a/sqlalchemy_utils/functions/orm.py b/sqlalchemy_utils/functions/orm.py
index 960738a..594e483 100644
--- a/sqlalchemy_utils/functions/orm.py
+++ b/sqlalchemy_utils/functions/orm.py
@@ -23,7 +23,28 @@ def get_mapper(mixed):
     """
     Return related SQLAlchemy Mapper for given SQLAlchemy object.
 
-    :param mixed: SQLAlchemy Table object
+    :param mixed: SQLAlchemy Table / Alias / Mapper / declarative model object
+
+    ::
+
+        from sqlalchemy_utils import get_mapper
+
+
+        get_mapper(User)
+
+        get_mapper(User())
+
+        get_mapper(User.__table__)
+
+        get_mapper(User.__mapper__)
+
+        get_mapper(sa.orm.aliased(User))
+
+        get_mapper(sa.orm.aliased(User.__table__))
+
+
+    Raises:
+        ValueError: if multiple mappers were found for given argument
 
     .. versionadded: 0.26.1
     """