Skip to content

Commit

Permalink
Add docs covering shadowing support
Browse files Browse the repository at this point in the history
  • Loading branch information
timsavage committed Mar 4, 2024
1 parent 83e4874 commit 0ec48dd
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/ref/resources/options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Meta Options
to sort fields in the child resource before appending the fields from the parent
resource(s).

Settings this option to ``True`` will cause field sorting to happen after all of
Setting this option to ``True`` will cause field sorting to happen after all of
the fields have been attached using the default sort method. The default method
sorts the fields by the order they are defined.

Expand All @@ -112,4 +112,10 @@ Meta Options
class Meta:
user_data = {
"custom": "my-custom-value",
}
}

``allow_field_shadowing``
Allow fields to be shadow fields with the same name in a parent resource.

Setting this option to ``True`` will allow fields to be shadowed without an exception
being raised. The default behaviour is to raise an exception if a field is shadowed.

0 comments on commit 0ec48dd

Please sign in to comment.