Skip to content

Commit 0ec48dd

Browse files
committed
Add docs covering shadowing support
1 parent 83e4874 commit 0ec48dd

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

docs/ref/resources/options.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Meta Options
8585
to sort fields in the child resource before appending the fields from the parent
8686
resource(s).
8787

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

@@ -112,4 +112,10 @@ Meta Options
112112
class Meta:
113113
user_data = {
114114
"custom": "my-custom-value",
115-
}
115+
}
116+
117+
``allow_field_shadowing``
118+
Allow fields to be shadow fields with the same name in a parent resource.
119+
120+
Setting this option to ``True`` will allow fields to be shadowed without an exception
121+
being raised. The default behaviour is to raise an exception if a field is shadowed.

0 commit comments

Comments
 (0)