Skip to content

Commit a5be00b

Browse files
committed
docs: fix misleading description and add note
1 parent 6615763 commit a5be00b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

user_guide_src/source/models/entities.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,12 @@ fields are handled automatically by the class or the database, so we don't want
6868
to change those.
6969

7070
Finally, we've set our Entity class as the ``$returnType``. This ensures that all
71-
methods on the model that return rows from the database will return instances of
72-
our User Entity class instead of an object or array like normal.
71+
built-in methods on the model that return rows from the database will return
72+
instances of our User Entity class instead of an object or array like normal.
73+
74+
.. note::
75+
Of course, if you add a custom method to your model, you must implement it
76+
so that instances of ``$returnType`` are returned.
7377

7478
Working with the Entity Class
7579
=============================

0 commit comments

Comments
 (0)