Updated docstring
authorThierry Florac <tflorac@ulthar.net>
Fri, 13 Sep 2019 09:13:21 +0200
changeset 540 569a84612e79
parent 539 5f7cda8f9da3
child 541 c3ce940a0243
Updated docstring
src/pyams_skin/container.py
--- a/src/pyams_skin/container.py	Tue Sep 03 16:30:09 2019 +0200
+++ b/src/pyams_skin/container.py	Fri Sep 13 09:13:21 2019 +0200
@@ -55,6 +55,14 @@
       an internal server error is raised!
     If the function is called from another unprotected view with 'ignore_permission=True',
     it's a configuration error.
+
+    :param request: the current request
+    :param container_factory: adapter interface or factory which may be used to access required
+        container values
+    :param ignore_permission: if False, container's edit permission is checked and an exception is
+        raised if request doesn't have required permission; otherwise, no permission is checked.
+        This argument should be set to True only when the function is called from another view
+        which already checked required permission.
     """
     translate = request.localizer.translate
     # Get object name to be removed