From 4ea4ce712314ccbf95e4db373636db766c2823db Mon Sep 17 00:00:00 2001
From: Oscar Gustafsson <oscar.gustafsson@gmail.com>
Date: Sat, 4 Feb 2023 16:44:23 +0100
Subject: [PATCH] Some more docs
---
b_asic/GUI/drag_button.py | 10 +++++++++-
b_asic/GUI/port_button.py | 15 +++++++++++++++
b_asic/GUI/select_sfg_window.py | 4 ++++
b_asic/GUI/show_pc_window.py | 3 +++
b_asic/GUI/simulate_sfg_window.py | 3 +++
b_asic/scheduler_gui/axes_item.py | 2 +-
b_asic/scheduler_gui/scheduler_event.py | 23 +++++++++++++++++------
b_asic/scheduler_gui/scheduler_item.py | 3 ++-
b_asic/scheduler_gui/signal_item.py | 19 +++++++++++++++++++
9 files changed, 73 insertions(+), 9 deletions(-)
diff --git a/b_asic/GUI/drag_button.py b/b_asic/GUI/drag_button.py
index 9652b8a3..d2ee6015 100644
--- a/b_asic/GUI/drag_button.py
+++ b/b_asic/GUI/drag_button.py
@@ -28,7 +28,15 @@ class DragButton(QPushButton):
"""
Drag button class.
- This class creates a drag button which can be clicked, dragged and dropped.
+ This class creates a button which can be clicked, dragged and dropped.
+
+ Parameters
+ ----------
+ name
+ operation
+ is_show_name
+ window
+ parent
"""
connectionRequested = Signal(QPushButton)
diff --git a/b_asic/GUI/port_button.py b/b_asic/GUI/port_button.py
index 13e2e218..e9d448ae 100644
--- a/b_asic/GUI/port_button.py
+++ b/b_asic/GUI/port_button.py
@@ -1,8 +1,23 @@
+"""
+B-ASIC port button module.
+"""
from qtpy.QtCore import Qt, Signal
from qtpy.QtWidgets import QMenu, QPushButton
class PortButton(QPushButton):
+ """
+ A button corresponding to a port.
+
+ Parameters
+ ----------
+ name
+ operation
+ port
+ window
+ parent
+ """
+
connectionRequested = Signal(QPushButton)
moved = Signal()
diff --git a/b_asic/GUI/select_sfg_window.py b/b_asic/GUI/select_sfg_window.py
index 0dc2e3f3..a2105449 100644
--- a/b_asic/GUI/select_sfg_window.py
+++ b/b_asic/GUI/select_sfg_window.py
@@ -1,3 +1,7 @@
+"""
+B-ASIC select SFG window.
+"""
+
from qtpy.QtCore import Qt, Signal
from qtpy.QtWidgets import QComboBox, QDialog, QPushButton, QVBoxLayout
diff --git a/b_asic/GUI/show_pc_window.py b/b_asic/GUI/show_pc_window.py
index 0a8c7dad..43ffc5ea 100644
--- a/b_asic/GUI/show_pc_window.py
+++ b/b_asic/GUI/show_pc_window.py
@@ -1,3 +1,6 @@
+"""
+B-ASIC window to show precedence graph.
+"""
from qtpy.QtCore import Qt, Signal
from qtpy.QtWidgets import (
QCheckBox,
diff --git a/b_asic/GUI/simulate_sfg_window.py b/b_asic/GUI/simulate_sfg_window.py
index 926d63fa..8989d75d 100644
--- a/b_asic/GUI/simulate_sfg_window.py
+++ b/b_asic/GUI/simulate_sfg_window.py
@@ -1,3 +1,6 @@
+"""
+B-ASIC window to simulate an SFG.
+"""
from matplotlib.backends.backend_qt5agg import (
FigureCanvasQTAgg as FigureCanvas,
)
diff --git a/b_asic/scheduler_gui/axes_item.py b/b_asic/scheduler_gui/axes_item.py
index 63b2ebd6..62afca24 100644
--- a/b_asic/scheduler_gui/axes_item.py
+++ b/b_asic/scheduler_gui/axes_item.py
@@ -59,7 +59,7 @@ class AxesItem(QGraphicsItemGroup):
parent: Optional[QGraphicsItem] = None,
):
"""
- Constructs a AxesItem.
+ Construct an AxesItem.
*parent* is passed to QGraphicsItemGroup's constructor.
"""
super().__init__(parent=parent)
diff --git a/b_asic/scheduler_gui/scheduler_event.py b/b_asic/scheduler_gui/scheduler_event.py
index ce8c744f..ca40bd8a 100644
--- a/b_asic/scheduler_gui/scheduler_event.py
+++ b/b_asic/scheduler_gui/scheduler_event.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
-"""B-ASIC Scheduler-gui Graphics Graph Event Module.
+"""
+B-ASIC Scheduler-gui Graphics Graph Event Module.
Contains the scheduler-gui SchedulerEvent class containing event filters and handlers for SchedulerItem objects.
"""
@@ -27,7 +28,14 @@ from b_asic.scheduler_gui.timeline_item import TimelineItem
class SchedulerEvent: # PyQt5
- """Event filter and handlers for SchedulerItem"""
+ """
+ Event filter and handlers for SchedulerItem.
+
+ Parameters
+ ----------
+ parent : QGraphicsItem, optional
+ The parent QGraphicsItem.
+ """
class Signals(QObject): # PyQt5
"""A class representing signals."""
@@ -94,8 +102,10 @@ class SchedulerEvent: # PyQt5
...
def removeSceneEventFilters(self, filterItems) -> None:
- """Removes an event filter on 'filterItems' from 'self'. 'filterItems' can
- be one object or a list of objects."""
+ """
+ Removes an event filter on *filterItems* from *self*. *filterItems* can
+ be one object or a list of objects.
+ """
item: OperationItem
for item in filterItems:
item.removeSceneEventFilter(self)
@@ -220,7 +230,7 @@ class SchedulerEvent: # PyQt5
def comp_mousePressEvent(self, event: QGraphicsSceneMouseEvent) -> None:
"""
Changes the cursor to ClosedHandCursor when grabbing an object and
- stores the current position in item's parent coordinates. 'event' will
+ stores the current position in item's parent coordinates. *event* will
by default be accepted, and this item is then the mouse grabber. This
allows the item to receive future move, release and double-click events.
"""
@@ -284,7 +294,8 @@ class SchedulerEvent: # PyQt5
def timeline_mousePressEvent(
self, event: QGraphicsSceneMouseEvent
) -> None:
- """Store the current position in item's parent coordinates. 'event' will
+ """
+ Store the current position in item's parent coordinates. *event* will
by default be accepted, and this item is then the mouse grabber. This
allows the item to receive future move, release and double-click events.
"""
diff --git a/b_asic/scheduler_gui/scheduler_item.py b/b_asic/scheduler_gui/scheduler_item.py
index bfa7c647..c0b80a77 100644
--- a/b_asic/scheduler_gui/scheduler_item.py
+++ b/b_asic/scheduler_gui/scheduler_item.py
@@ -1,6 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
-"""B-ASIC Scheduler-gui Graphics Graph Item Module.
+"""
+B-ASIC Scheduler-gui Graphics Graph Item Module.
Contains the scheduler-gui SchedulerItem class for drawing and
maintain a component in a graph.
diff --git a/b_asic/scheduler_gui/signal_item.py b/b_asic/scheduler_gui/signal_item.py
index b8ca7337..4529c475 100644
--- a/b_asic/scheduler_gui/signal_item.py
+++ b/b_asic/scheduler_gui/signal_item.py
@@ -17,6 +17,21 @@ from b_asic.signal import Signal
class SignalItem(QGraphicsPathItem):
+ """
+ Class representing a signal in the scheduler GUI.
+
+ Parameters
+ ----------
+ src_operation : OperationItem
+ The operation that the signal is drawn from.
+ dest_operation : OperationItem
+ The operation that the signal is drawn to.
+ signal : Signal
+ The signal on the SFG level.
+ parent : QGraphicsItem, optional
+ The parent QGraphicsItem.
+ """
+
_path: Optional[QPainterPath] = None
_src_operation: OperationItem
_dest_operation: OperationItem
@@ -79,6 +94,7 @@ class SignalItem(QGraphicsPathItem):
self.setPath(path)
def refresh_pens(self):
+ """Create pens."""
pen = QPen(SIGNAL_ACTIVE)
pen.setWidthF(SIGNAL_WIDTH)
self._active_pen = pen
@@ -87,7 +103,10 @@ class SignalItem(QGraphicsPathItem):
self._inactive_pen = pen
def set_active(self):
+ """Set the signal color to represent that a connected operation is selected.
+ """
self.setPen(self._active_pen)
def set_inactive(self):
+ """Set the signal color to the default color."""
self.setPen(self._inactive_pen)
--
GitLab