From a06d45f1de9e927cdf969b52a3540d8e75f995a7 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Tue, 30 Apr 2024 08:37:20 +0200
Subject: [PATCH] DOC: Small additions.
---
src/linkahead/common/models.py | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 65b945ce..abcf0b2d 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -1453,6 +1453,9 @@ out: List[Entity]
def update_acl(self, **kwargs):
"""Update this entity's ACL on the server.
+ A typical workflow is to first edit ``self.acl`` and then call this
+ method.
+
Note
----
This overwrites any existing ACL, so you may want to run
@@ -1461,8 +1464,9 @@ out: List[Entity]
Parameters
----------
**kwargs : dict
- Keyword arguments that are being passed through to the
- ``Entity.update`` method.
+ Keyword arguments that are passed through to the
+ ``Entity.update`` method. Useful for e.g. ``unique=False`` in the
+ case of naming collisions.
Returns
-------
--
GitLab