Added docstrings to the TerminalUi class

1 files changed, 11 insertions, 0 deletions

diff --git a/src/frontEnd/TerminalUi.py b/src/frontEnd/TerminalUi.py
index 21b5b557..24ee4596 100644
--- a/src/frontEnd/TerminalUi.py
+++ b/src/frontEnd/TerminalUi.py
@@ -3,7 +3,18 @@ import os
 
 
 class TerminalUi(QtWidgets.QMainWindow):
+    """This is a class that represents the GUI required to provide
+    details regarding the ngspice simulation. This GUI consists of
+    a progress bar, a console window which displays the log of the
+    simulation and button required for re-simulation and cancellation
+    of the simulation"""
     def __init__(self, qProcess, args):
+        """The constructor of the TerminalUi class
+        param: qProcess: a PyQt QProcess that runs ngspice
+        type: qProcess: :class:`QtCore.QProcess`
+        param: args: arguments to be passed on to the ngspice call
+        type: args: list
+        """
         super(TerminalUi, self).__init__()
 
 #        Other variables