From 46bac13444fb0715d4a8980aa7235b8dd85c493d Mon Sep 17 00:00:00 2001
From: Micah Nordland <micah@rehack.me>
Date: Tue, 26 Jan 2016 13:16:32 -0500
Subject: Added function docstring to UI.handle_signal

---
 alot/ui.py | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'alot')

diff --git a/alot/ui.py b/alot/ui.py
index 54697297..8dff2839 100644
--- a/alot/ui.py
+++ b/alot/ui.py
@@ -641,6 +641,15 @@ class UI(object):
             d.addCallback(call_posthook)
             return d
     def handle_signal(self, signum, frame):
+        """
+        handles UNIX signals
+
+        This function currently just handles SIGUSR1. It could be extended to
+        handle more
+
+        :param signum: The signal number (see man 7 signal)
+        :param frame: The execution frame (https://docs.python.org/2/reference/datamodel.html#frame-objects)
+        """
         self.current_buffer.rebuild()
         self.update()
 
-- 
cgit v1.2.3