docs: Add docs for AbstractChildProcess methods

achimnol · Jan 11, 2021 · 634fd18 · 634fd18
1 parent ae01871
commit 634fd18
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/aiotools/fork.py b/src/aiotools/fork.py
@@ -60,10 +60,21 @@ class AbstractChildProcess(metaclass=ABCMeta):
 
     @abstractmethod
     def send_signal(self, signum: int) -> None:
+        """
+        Send a UNIX signal to the child process.
+        If the child process is already terminated, it will log
+        a warning message and return.
+        """
         raise NotImplementedError
 
     @abstractmethod
     async def wait(self) -> int:
+        """
+        Wait until the child process terminates or reclaim the child process' exit
+        code if already terminated.
+        If there are other coroutines that has waited the same process, it may
+        return 255 and log a warning message.
+        """
         raise NotImplementedError