Skip to content

Commit 65c4827

Browse files
committed
reorder args
1 parent 827f8d6 commit 65c4827

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

synapseclient/models/mixins/access_control.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -219,8 +219,8 @@ async def main():
219219
async def delete_permissions_async(
220220
self,
221221
include_self: bool = True,
222-
recursive: bool = False,
223222
include_container_content: bool = False,
223+
recursive: bool = False,
224224
target_entity_types: Optional[List[str]] = None,
225225
*,
226226
synapse_client: Optional[Synapse] = None,
@@ -242,16 +242,15 @@ async def delete_permissions_async(
242242
243243
Arguments:
244244
include_self: If True (default), delete the ACL of the current entity.
245-
If False, skip deleting the ACL of the current entity and only process
246-
children if recursive=True and include_container_content=True.
245+
If False, skip deleting the ACL of the current entity.
246+
include_container_content: If True, delete ACLs from contents directly within
247+
containers (files and folders inside self). This must be set to
248+
True for recursive to have any effect. Defaults to False.
247249
recursive: If True and the entity is a container (e.g., Project or Folder),
248250
recursively process child containers. Note that this must be used with
249251
include_container_content=True to have any effect. Setting recursive=True
250252
with include_container_content=False will raise a ValueError.
251253
Only works on classes that support the `sync_from_synapse_async` method.
252-
include_container_content: If True, delete ACLs from contents directly within
253-
containers (files and folders inside Projects/Folders). This must be set to
254-
True for recursive to have any effect. Defaults to False.
255254
target_entity_types: Specify which entity types to process when deleting ACLs.
256255
Allowed values are "folder" and "file" (case-insensitive).
257256
If None, defaults to ["folder", "file"].

synapseclient/models/protocols/access_control_protocol.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,9 @@ def set_permissions(
166166

167167
def delete_permissions(
168168
self,
169-
recursive: bool = False,
170169
include_self: bool = True,
171170
include_container_content: bool = False,
171+
recursive: bool = False,
172172
target_entity_types: Optional[List[str]] = None,
173173
*,
174174
synapse_client: Optional[Synapse] = None,
@@ -190,16 +190,15 @@ def delete_permissions(
190190
191191
Arguments:
192192
include_self: If True (default), delete the ACL of the current entity.
193-
If False, skip deleting the ACL of the current entity and only process
194-
children if recursive=True and include_container_content=True.
193+
If False, skip deleting the ACL of the current entity.
194+
include_container_content: If True, delete ACLs from contents directly within
195+
containers (files and folders inside self). This must be set to
196+
True for recursive to have any effect. Defaults to False.
195197
recursive: If True and the entity is a container (e.g., Project or Folder),
196198
recursively process child containers. Note that this must be used with
197199
include_container_content=True to have any effect. Setting recursive=True
198200
with include_container_content=False will raise a ValueError.
199201
Only works on classes that support the `sync_from_synapse_async` method.
200-
include_container_content: If True, delete ACLs from contents directly within
201-
containers (files and folders inside Projects/Folders). This must be set to
202-
True for recursive to have any effect. Defaults to False.
203202
target_entity_types: Specify which entity types to process when deleting ACLs.
204203
Allowed values are "folder" and "file" (case-insensitive).
205204
If None, defaults to ["folder", "file"].

0 commit comments

Comments
 (0)