Skip to content

docs: add docs for dict() method #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoanFM merged 1 commit into from
Jul 5, 2023
Merged

docs: add docs for dict() method #1643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docarray/base_doc/doc.py
View file
Open in desktop
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