linux: docstring and typhint for readchar()

Cube707 · Cube707 · commit 76eecf5e552e · 2022-07-25T11:33:30.000+02:00
diff --git a/readchar/_posix_read.py b/readchar/_posix_read.py
@@ -2,10 +2,14 @@
 import termios
 import tty
 
+
 # Initially taken from:
 # http://code.activestate.com/recipes/134892/
 # Thanks to Danny Yoo
-def readchar():
+def readchar() -> str:
+    """Reads a single character from the input stream.
+    Blocks until a character is available."""
+
     fd = sys.stdin.fileno()
     old_settings = termios.tcgetattr(fd)
     try:
