Skip to content

Commit 2a9a56f

Browse files
committed
clarify get_invalid_validation to mention only results from direct children are returned
1 parent 74cc58f commit 2a9a56f

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

‎synapseclient/models/mixins/json_schema.py‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,10 @@ async def get_invalid_validation_async(
977977
"""
978978
Get invalid JSON schema validation results for a container entity.
979979
980+
Note: This only checks the direct children of this entity. It does not
981+
check this entity itself, and it does not check grandchildren (entities
982+
nested two or more levels below this entity).
983+
980984
Arguments:
981985
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
982986
the last created instance from the Synapse class constructor will be used.
@@ -1126,6 +1130,10 @@ def get_invalid_validation(
11261130
"""
11271131
Get invalid JSON schema validation results for a container entity.
11281132
1133+
Note: This only checks the direct children of this entity. It does not
1134+
check this entity itself, and it does not check grandchildren (entities
1135+
nested two or more levels below this entity).
1136+
11291137
Arguments:
11301138
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
11311139
the last created instance from the Synapse class constructor will be used.

0 commit comments

Comments
 (0)