From d888572535be53213c6fbd4e3c157abd5d3aa363 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 16 Jun 2023 12:31:40 +0200
Subject: [PATCH] DOC: CHanged wording of docstring to
remove_value_from_property
---
src/caosdb/common/models.py | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/src/caosdb/common/models.py b/src/caosdb/common/models.py
index 30009f8f..0a2eec19 100644
--- a/src/caosdb/common/models.py
+++ b/src/caosdb/common/models.py
@@ -466,15 +466,13 @@ class Entity:
Notes
-----
If the property value is a list and the value to be removed occurs more
- than once in this list, only it's first occurrance is deleted (similar
+ than once in this list, only its first occurrance is deleted (similar
to the behavior of Python's ``list.remove()``.)
If the property is already empty and a value != None is to be removed,
the property is not removed afterwards even if
- ``remove_if_empty_afterwards`` is set to ``True`` (since it hasn't been
- emptied **because** this function was called but rather didn't have a
- value in the first place). This changes if the value to be removed is
- set to ``None`` explicitly.
+ ``remove_if_empty_afterwards`` is set to ``True`` (the property being
+ empty is not an effect of calling this function).
Parameters
----------
--
GitLab