From 602aeef4d4d70b9fe8c6a1e318538697b3e23bfc Mon Sep 17 00:00:00 2001
From: Araq <rumpf_a@web.de>
Date: Mon, 3 Sep 2018 11:40:14 +0200
Subject: manual: document the 'unsafeAddr' operator; closes #5038

---
 doc/manual.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'doc')

diff --git a/doc/manual.rst b/doc/manual.rst
index 6e1030e7e..e3199cecf 100644
--- a/doc/manual.rst
+++ b/doc/manual.rst
@@ -3105,6 +3105,19 @@ the address of variables, but one can't use it on variables declared through
   # Error: expression has no address
 
 
+The unsafeAddr operator
+-----------------------
+
+For easier interoperability with other compiled languages such as C, retrieving
+the address of a ``let`` variable, a parameter or a ``for`` loop variable, the
+``unsafeAddr`` operation can be used:
+
+.. code-block:: nim
+
+  let myArray = [1, 2, 3]
+  foreignProcThatTakesAnAddr(unsafeAddr myArray)
+
+
 Procedures
 ==========
 
-- 
cgit 1.4.1-2-gfad0