Add docblocks

Author: robertbasic

pugdebug/debugger.py

@@ -71,10 +71,11 @@ def connect_server_signals(self):
     def connect_connection_signals(self, connection):
         """Connect signals for a new connection
 
-        Connect signals that gets emitted when a connection is stopped
-        or detached, when a step command is done, when variables are read,
-        when stacktraces are read, when breakpoints are set or removed,
-        when breakpoints are read, when expressions are evaluated.
+        Connect signals that gets emitted when post start commands are done,
+        a connection is stopped or detached, when a step command is done,
+        when variables are read, when stacktraces are read, when breakpoints
+        are set or removed, when breakpoints are read, when expressions are
+        evaluated.
         """
 
         # Stop/detach signals
@@ -195,12 +196,24 @@ def start_new_connection(self):
         self.debugging_started_signal.emit()
 
     def post_start_command(self, post_start_data):
+        """Issue a post start command
+
+        After a debugging session is started, set the init breakpoints
+        and list the breakpoints.
+        """
         self.current_connection.post_start_command(post_start_data)
 
     def handle_post_start(self):
+        """Handle post start command
+        """
         self.debugging_post_start_signal.emit()
 
     def handle_server_stopped(self):
+        """Handle when the server is stopped
+
+        If the current connection is terminated, cleanup the debugging
+        session and emit the debugging stopped signal.
+        """
         if not self.is_connected():
             self.cleanup()
             self.debugging_stopped_signal.emit()
@@ -310,9 +323,15 @@ def handle_expressions_evaluated(self, results):
         self.expressions_evaluated_signal.emit(results)
 
     def handle_server_error(self, error):
+        """Handle when an error occurs in the server
+        """
         self.error_signal.emit(error)
 
     def handle_connection_error(self, action, error):
+        """Handle when an error occurs in the connection
+
+        Kill the current connection and stop debugging.
+        """
         error = error + " during %s action" % action
         self.error_signal.emit(error)
 

pugdebug/pugdebug.py

@@ -78,6 +78,10 @@ def setup_file_browser(self):
         self.file_browser.hide_columns()
 
     def setup_projects_browser(self):
+        """Setup the projects browser
+
+        Sets the model on the projects browser.
+        """
         model = PugdebugProjects(self)
 
         self.projects_browser.setModel(model)
@@ -108,6 +112,14 @@ def connect_file_browser_signals(self):
         self.file_browser.activated.connect(self.file_browser_item_activated)
 
     def connect_projects_browser_signals(self):
+        """Connect projects browser signals
+
+        Connects the projects browser's activated signal to the
+        slot that gets called when a project browser item is activated.
+
+        Connects the signal that gets emitted from the main window
+        when a new project gets created.
+        """
         self.projects_browser.activated.connect(
             self.projects_browser_item_activated
         )
@@ -229,6 +241,12 @@ def connect_breakpoint_viewer_signals(self):
         )
 
     def handle_new_project_created(self, project_name):
+        """Handle when a new project gets created
+
+        Reload the projects in the projects browser.
+
+        Find the project that was just created and load it.
+        """
         self.projects_browser.load_projects()
 
         item = self.projects_browser.model().findItems(project_name)[0]
@@ -237,10 +255,19 @@ def handle_new_project_created(self, project_name):
         self.load_project(project)
 
     def projects_browser_item_activated(self, index):
+        """Handle when a projects browser item gets activated
+
+        Find the project and load it.
+        """
         project = self.projects_browser.model().get_project_by_index(index)
         self.load_project(project)
 
     def load_project(self, project):
+        """Load a project
+
+        Get the settings for the project and load them as the current
+        application settings.
+        """
         project_settings = project.get_settings()
 
         changed_settings = save_settings(project_settings)
@@ -745,6 +772,10 @@ def handle_expression_added_or_changed(self, index, expression):
             self.debugger.evaluate_expression(index, expression)
 
     def handle_error(self, error):
+        """Handle when an error occurs
+
+        Show the error in an error message window.
+        """
         em = QErrorMessage(self.main_window)
         em.showMessage(error)