From 4f5b51df14f2d272b04a7b7930df8b0148b37465 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Orvisk=C3=BD?= <orvisky.tomas@centrum.cz>
Date: Sun, 28 Jan 2024 19:44:17 +0100
Subject: [PATCH] DiagramClass docstring
---
src/pyplaml/diagram_class.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/src/pyplaml/diagram_class.py b/src/pyplaml/diagram_class.py
index 966b02b..c878188 100644
--- a/src/pyplaml/diagram_class.py
+++ b/src/pyplaml/diagram_class.py
@@ -10,7 +10,6 @@ from .diagram_object import DiagramObject
class DiagramClass(DiagramObject):
-
def __init__(self,
name: str,
edges: List[DiagramEdge] = None,
@@ -67,6 +66,8 @@ class DiagramClass(DiagramObject):
return self.edges
def get_edge_to(self, target: DiagramObject) -> DiagramEdge | None:
+ """Returns edge to target if it exists in this class."""
+
for e in self.edges:
if e.target == target:
return e
@@ -92,6 +93,7 @@ class DiagramClass(DiagramObject):
self.redraw()
def set_show_icon(self, show_icon: bool):
+ """Sets if the class icon should be drawn."""
self.__show_icon = show_icon
self.redraw()
@@ -209,6 +211,8 @@ class DiagramClass(DiagramObject):
@staticmethod
def get_icon(text: str, colour) -> VMobject:
+ """Returns VGroup representing icon for DiagramClass."""
+
c = Circle(color=BLACK, fill_color=colour, stroke_width=2, fill_opacity=1)
t = Text(text, color=BLACK)
c.surround(t, buffer_factor=1.6)
--
GitLab