From a5be00b6be4d1d8857c37e4c01c3056099ef78f4 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 26 Feb 2024 17:37:27 +0900 Subject: [PATCH] docs: fix misleading description and add note --- user_guide_src/source/models/entities.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/models/entities.rst b/user_guide_src/source/models/entities.rst index 202e39ed7365..bcc0c2ec57d0 100644 --- a/user_guide_src/source/models/entities.rst +++ b/user_guide_src/source/models/entities.rst @@ -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 =============================