borrow dots for distinct types documented

1 files changed, 22 insertions, 0 deletions

diff --git a/doc/manual.txt b/doc/manual.txt
index c2acd3e6a..6526ba2cb 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -1569,6 +1569,28 @@ currency. This can be solved with templates_.
   defineCurrency(TEuro, int)
 
 
+The borrow pragma can also be used to annotate the distinct type to allow
+certain builtin operations to be lifted:
+
+.. code-block:: nimrod
+  type
+    Foo = object
+      a, b: int
+      s: string
+
+    Bar {.borrow: `.`.} = distinct Foo
+
+  var bb: ref Bar
+  new bb
+  # field access now valid
+  bb.a = 90
+  bb.s = "abc"
+
+Currently only the dot accessor can be borrowed in this way.
+
+
+
+
 Void type
 ---------