From 23c4bbedcbf12a7ab87baefe589b472837d89dbf Mon Sep 17 00:00:00 2001
From: nblaxall <43897322+nblaxall@users.noreply.github.com>
Date: Thu, 20 Jan 2022 00:25:21 +1300
Subject: add an example to setControlCHook (#19416)

* add an example to setControlCHook

* [skip CI] format example for setControlCHook

Co-authored-by: Nathan Blaxall <nathan.blaxall@actionstep.com>
---
 lib/system.nim | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'lib/system.nim')

diff --git a/lib/system.nim b/lib/system.nim
index 02da048e4..09de9fcde 100644
--- a/lib/system.nim
+++ b/lib/system.nim
@@ -2319,6 +2319,15 @@ when notJSnotNims:
   proc setControlCHook*(hook: proc () {.noconv.})
     ## Allows you to override the behaviour of your application when CTRL+C
     ## is pressed. Only one such hook is supported.
+    ## Example:
+    ##
+    ## .. code-block:: Nim
+    ##   proc ctrlc() {.noconv.} =
+    ##     echo "Ctrl+C fired!"
+    ##     # do clean up stuff
+    ##     quit()
+    ##
+    ##   setControlCHook(ctrlc)
 
   when not defined(noSignalHandler) and not defined(useNimRtl):
     proc unsetControlCHook*()
-- 
cgit 1.4.1-2-gfad0