Skip to content

Commit

Permalink
docs: fix misleading description and add note
Browse files Browse the repository at this point in the history
  • Loading branch information
kenjis committed Feb 26, 2024
1 parent 6615763 commit a5be00b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions user_guide_src/source/models/entities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,12 @@ fields are handled automatically by the class or the database, so we don't want
to change those.

Finally, we've set our Entity class as the ``$returnType``. This ensures that all
methods on the model that return rows from the database will return instances of
our User Entity class instead of an object or array like normal.
built-in methods on the model that return rows from the database will return
instances of our User Entity class instead of an object or array like normal.

.. note::
Of course, if you add a custom method to your model, you must implement it
so that instances of ``$returnType`` are returned.

Working with the Entity Class
=============================
Expand Down

0 comments on commit a5be00b

Please sign in to comment.