From 85d807d332542485f12a3cdfd235a6b587f54c85 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Fri, 24 Jan 2025 11:05:06 +0100
Subject: [PATCH] DOC: add docstrings
---
src/linkahead/common/models.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/linkahead/common/models.py b/src/linkahead/common/models.py
index 0912647a..12d36179 100644
--- a/src/linkahead/common/models.py
+++ b/src/linkahead/common/models.py
@@ -506,6 +506,7 @@ class Entity:
return self
def get_versionid(self):
+ """Returns the concatenation of ID and version"""
return str(self.id)+"@"+str(self.version.id)
def get_importance(self, property): # @ReservedAssignment
@@ -2131,9 +2132,11 @@ class Property(Entity):
def value_matches_versionid(self):
+ """Returns True if the value matches the pattern <id>@<version>"""
return value_matches_versionid(self.value)
def get_id_from_versionid_value(self):
+ """Returns the ID part of the versionid with the pattern <id>@<version>"""
return get_id_from_versionid(self.value)
class Message(object):
@@ -5682,6 +5685,7 @@ def _filter_entity_list_by_identity(listobject: list[Entity],
return matches
def value_matches_versionid(value: Union[int, str]):
+ """Returns True if the value matches the pattern <id>@<version>"""
if isinstance(value, int):
return False
if not isinstance(value, str):
@@ -5690,4 +5694,5 @@ def value_matches_versionid(value: Union[int, str]):
return "@" in value
def get_id_from_versionid(versionid: str):
+ """Returns the ID part of the versionid with the pattern <id>@<version>"""
return versionid.split("@")[0]
--
GitLab