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

docs: fix highlight of code example in "Providing values for nested data" #3815

Merged
merged 3 commits into from
Oct 17, 2024
Merged

docs: fix highlight of code example in "Providing values for nested data" #3815

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
164bf11
docs: fix highlight of code example in "Providing values for nested d…
sobolevn Oct 16, 2024
363645f
Merge branch 'main' into dto-values-for-nested-data
provinzkraut Oct 17, 2024
21f0606
Merge branch 'main' into dto-values-for-nested-data
sobolevn Oct 17, 2024
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
4 changes: 2 additions & 2 deletions docs/usage/dto/1-abstract-dto.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ nested model with excluded fields.

.. literalinclude:: /examples/data_transfer_objects/factory/providing_values_for_nested_data.py
:language: python
:emphasize-lines: 10,11,12,13,21,29,35
:emphasize-lines: 9-12,20,28,34
:linenos:

The double-underscore syntax ``address__id`` passed as a keyword argument to the
Expand All @@ -239,7 +239,7 @@ nested attribute. In this case, it's used to provide a value for the ``id`` attr
within the ``Person`` instance.

This is a common convention in Python for dealing with nested structures. The double underscore can be interpreted as
"traverse through", so ``address__id`` means "traverse through address to get to id".
"traverse through", so ``address__id`` means "traverse through address to get to its id".

In the context of this script, ``create_instance(id=1, address__id=2)`` is saying "create a new ``Person`` instance from
the client data given an id of ``1``, and supplement the client address data with an id of ``2``".
Expand Down
Loading