improve docs for LazyTableReference

piccolo-orm · Jun 27, 2024 · a363cbf · a363cbf
1 parent f1fbcc3
commit a363cbf
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/src/piccolo/schema/m2m.rst b/docs/src/piccolo/schema/m2m.rst
@@ -54,8 +54,9 @@ We create it in Piccolo like this:
 
 
 .. note::
-    We use ``LazyTableReference`` because when Python evaluates ``Band`` and
-    ``Genre``, the ``GenreToBand`` class doesn't exist yet.
+    We use :class:`LazyTableReference <piccolo.columns.reference.LazyTableReference>`
+    because when Python evaluates ``Band`` and ``Genre``, the ``GenreToBand``
+    class doesn't exist yet.
 
 By using ``M2M`` it unlocks some powerful and convenient features.
 

diff --git a/piccolo/columns/reference.py b/piccolo/columns/reference.py
@@ -30,6 +30,9 @@ class LazyTableReference:
         If specified, the ``Table`` subclass is imported from this path.
         For example, ``'my_app.tables'``.
 
+        .. hint::
+            If the table is in the same file, you can pass in ``__name__``.
+
     """
 
     table_class_name: str