Skip to content
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

Jump to bottom

Update field docstring to reflect "attribute" argument affecting deserialization #2166

Closed
wants to merge 1 commit into from
Closed

Update field docstring to reflect "attribute" argument affecting deserialization #2166

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
2 changes: 1 addition & 1 deletion src/marshmallow/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class Field(FieldABC):
:param data_key: The name of the dict key in the external representation, i.e.
the input of `load` and the output of `dump`.
If `None`, the key will match the name of the field.
:param attribute: The name of the attribute to get the value from when serializing.
:param attribute: The name of the attribute to get the value from when (de)serializing.
If `None`, assumes the attribute has the same name as the field.
Note: This should only be used for very specific use cases such as
outputting multiple fields for a single attribute. In most cases,
Expand Down