Skip to content

Commit

Permalink
docs: add docs for dict() method (#1643)
Browse files Browse the repository at this point in the history
Signed-off-by: punndcoder28 <puneethk.2899@gmail.com>
  • Loading branch information
punndcoder28 committed Jul 5, 2023
1 parent d265523 commit 5089bda
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docarray/base_doc/doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""

Expand Down

0 comments on commit 5089bda

Please sign in to comment.