Skip to content

Commit f036757

Browse files
committed
use Arguments instead of Args
1 parent b10c21d commit f036757

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

synapseclient/api/json_schema_services.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ async def get_json_schema_validation_statistics(
106106
) -> "JSONSchemaValidationStatistics":
107107
"""Get the summary statistic of json schema validation results for
108108
a container entity
109-
Arguments:
109+
Arguments:
110110
synapse_id: Synapse Id
111111
synapse_client: If not passed in and caching was not disabled by
112112
`Synapse.allow_client_caching(False)` this will use the last created
@@ -152,7 +152,7 @@ async def get_json_schema_derived_keys(
152152
) -> "JSONSchemaDerivedKeys":
153153
"""Retrieve derived JSON schema keys for a given Synapse entity.
154154
155-
Args:
155+
Arguments:
156156
synapse_id (str): The Synapse ID of the entity for which to retrieve derived keys.
157157
158158
Returns:

synapseclient/models/mixins/json_schema.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ async def bind_schema_async(
201201
"""
202202
Bind a JSON schema to the entity.
203203
204-
Args:
204+
Arguments:
205205
json_schema_uri (str): The URI of the JSON schema to bind to the entity.
206206
enable_derived_annos (bool, optional): If true, enable derived annotations. Defaults to False.
207207
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
@@ -243,7 +243,7 @@ async def get_schema_async(
243243
"""
244244
Get the JSON schema bound to the entity.
245245
246-
Args:
246+
Arguments:
247247
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
248248
the last created instance from the Synapse class constructor will be used.
249249
@@ -282,7 +282,7 @@ async def delete_schema_async(
282282
"""
283283
Delete the JSON schema bound to the entity.
284284
285-
Args:
285+
Arguments:
286286
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
287287
the last created instance from the Synapse class constructor will be used.
288288
"""
@@ -296,7 +296,7 @@ async def validate_schema_async(
296296
"""
297297
Validate the entity against the bound JSON schema.
298298
299-
Args:
299+
Arguments:
300300
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
301301
the last created instance from the Synapse class constructor will be used.
302302
@@ -367,7 +367,7 @@ async def get_schema_derived_keys_async(
367367
"""
368368
Retrieve derived JSON schema keys for the entity.
369369
370-
Args:
370+
Arguments:
371371
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
372372
the last created instance from the Synapse class constructor will be used.
373373
@@ -394,7 +394,7 @@ async def get_schema_validation_statistics_async(
394394
"""
395395
Get validation statistics for a container entity.
396396
397-
Args:
397+
Arguments:
398398
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
399399
the last created instance from the Synapse class constructor will be used.
400400
@@ -418,7 +418,7 @@ async def get_invalid_validation_async(
418418
"""
419419
Get invalid JSON schema validation results for a container entity.
420420
421-
Args:
421+
Arguments:
422422
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
423423
the last created instance from the Synapse class constructor will be used.
424424

synapseclient/models/protocols/json_schema_protocol.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def bind_schema(
3030
"""
3131
Bind a JSON schema to the entity.
3232
33-
Args:
33+
Arguments:
3434
json_schema_uri (str): The URI of the JSON schema to bind to the entity.
3535
enable_derived_annos (bool, optional): If true, enable derived annotations. Defaults to False.
3636
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
@@ -47,7 +47,7 @@ def get_schema(
4747
"""
4848
Get the JSON schema bound to the entity.
4949
50-
Args:
50+
Arguments:
5151
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
5252
the last created instance from the Synapse class constructor will be used.
5353
@@ -60,7 +60,7 @@ def delete_schema(self, *, synapse_client: Optional["Synapse"] = None) -> None:
6060
"""
6161
Delete the JSON schema bound to the entity.
6262
63-
Args:
63+
Arguments:
6464
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
6565
the last created instance from the Synapse class constructor will be used.
6666
"""
@@ -71,7 +71,7 @@ def validate_schema(
7171
"""
7272
Validate the entity against the bound JSON schema.
7373
74-
Args:
74+
Arguments:
7575
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
7676
the last created instance from the Synapse class constructor will be used.
7777
@@ -86,7 +86,7 @@ def get_schema_derived_keys(
8686
"""
8787
Retrieve derived JSON schema keys for the entity.
8888
89-
Args:
89+
Arguments:
9090
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
9191
the last created instance from the Synapse class constructor will be used.
9292
@@ -109,7 +109,7 @@ def get_schema_validation_statistics(
109109
"""
110110
Get validation statistics for a container entity.
111111
112-
Args:
112+
Arguments:
113113
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
114114
the last created instance from the Synapse class constructor will be used.
115115
@@ -124,7 +124,7 @@ def get_invalid_validation(
124124
"""
125125
Get invalid JSON schema validation results for a container entity.
126126
127-
Args:
127+
Arguments:
128128
synapse_client (Optional[Synapse], optional): The Synapse client instance. If not provided,
129129
the last created instance from the Synapse class constructor will be used.
130130

0 commit comments

Comments
 (0)