瀏覽代碼

Fix docstrings for signal methods
The 'signal' arg is a string that can accept a name or number.

Mike Naberezny 10 年之前
父節點
當前提交
fd5d8b11a9
共有 1 個文件被更改,包括 8 次插入8 次删除
  1. 8 8
      supervisor/rpcinterface.py

+ 8 - 8
supervisor/rpcinterface.py

@@ -469,9 +469,9 @@ class SupervisorNamespaceRPCInterface:
     def signalProcess(self, name, signal):
         """ Send an arbitrary UNIX signal to the process named by name
 
-        @param string name The name of the process to signal (or 'group:name')
-        @param int signal the integer UNIX signal to send.
-        @return boolean result
+        @param string name    Name of the process to signal (or 'group:name')
+        @param string signal  Signal to send, as name ('HUP') or number ('1')
+        @return boolean
         """
 
         self._update('signalProcess')
@@ -500,9 +500,9 @@ class SupervisorNamespaceRPCInterface:
     def signalProcessGroup(self, name, signal):
         """ Send a signal to all processes in the group named 'name'
 
-        @param string name  The group name
-        @param int signal   The signal to be sent.
-        @return array result
+        @param string name    The group name
+        @param string signal  Signal to send, as name ('HUP') or number ('1')
+        @return array
         """
 
         group = self.supervisord.process_groups.get(name)
@@ -525,8 +525,8 @@ class SupervisorNamespaceRPCInterface:
     def signalAllProcesses(self, signal):
         """ Send a signal to all processes in the process list
 
-        @param int signal   The signal to be sent.
-        @return array result   An array of process status info structs
+        @param string signal  Signal to send, as name ('HUP') or number ('1')
+        @return array         An array of process status info structs
         """
         processes = self._getAllProcesses()
         signalall = make_allfunc(processes, isRunning, self.signalProcess,