summary refs log tree commit diff stats
diff options
context:
space:
mode:
authordef <dennis@felsin9.de>2015-02-04 14:10:58 +0100
committerdef <dennis@felsin9.de>2015-02-04 14:10:58 +0100
commit8640efcd4053353fe97da1a1950ad1c370565a4b (patch)
tree1761ad90059acd867189c03be20c424141de185a
parente7eab49e14e4764cecaf6e415d71556238f5642b (diff)
downloadNim-8640efcd4053353fe97da1a1950ad1c370565a4b.tar.gz
Document terminal.getch
-rw-r--r--lib/pure/terminal.nim2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/pure/terminal.nim b/lib/pure/terminal.nim
index b0c822c57..e0e2aa247 100644
--- a/lib/pure/terminal.nim
+++ b/lib/pure/terminal.nim
@@ -365,6 +365,8 @@ macro styledEcho*(m: varargs[expr]): stmt =
   result.add(newCall(bindSym"resetAttributes"))
 
 proc getch*(): char =
+  ## Read a single character from the terminal, blocking until it is entered.
+  ## The character is not printed to the terminal.
   when defined(windows):
     result = winGetch().char
   else: