From 90d46b8d6562b0110d75d39d29a8824818d639a1 Mon Sep 17 00:00:00 2001 From: punndcoder28 Date: Mon, 12 Jun 2023 22:40:13 +0530 Subject: [PATCH] docs: add docs for dic() method Signed-off-by: punndcoder28 --- docarray/base_doc/doc.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docarray/base_doc/doc.py b/docarray/base_doc/doc.py index 0dfbabd57c0..6ebeeb6b477 100644 --- a/docarray/base_doc/doc.py +++ b/docarray/base_doc/doc.py @@ -311,7 +311,11 @@ def dict( ) -> 'DictStrAny': """ Generate a dictionary representation of the model, optionally specifying - which fields to include or exclude. + which fields to include or exclude. The method also includes the attributes + and their values when attributes are objects of class types which can include + nesting. This method differs from the `dict()` method of python which only + prints the methods and attributes of the object and only the type of the + attribute when attributes are types of other class. """