summary refs log tree commit diff stats
path: root/doc/manual.txt
diff options
context:
space:
mode:
authorCharlie <bartoc@umich.edu>2014-05-18 18:48:12 -0400
committerCharlie <bartoc@umich.edu>2014-05-18 18:48:12 -0400
commite59ba5d8b2299bccdf842c9a55d355ebc87febff (patch)
tree34ace89fe7c3c75820d484d8d1507b4039370446 /doc/manual.txt
parente54ab22bf9a67353e5a70f56e7801624d68ca4f5 (diff)
downloadNim-e59ba5d8b2299bccdf842c9a55d355ebc87febff.tar.gz
added note about `$` for cstrings to the manual
Diffstat (limited to 'doc/manual.txt')
-rw-r--r--doc/manual.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/manual.txt b/doc/manual.txt
index d3a330e3a..fe4f0c038 100644
--- a/doc/manual.txt
+++ b/doc/manual.txt
@@ -965,6 +965,14 @@ stack roots conservatively. One can use the builtin procs ``GC_ref`` and
 ``GC_unref`` to keep the string data alive for the rare cases where it does
 not work.
 
+A `$` proc is defined for cstrings that returns a string. Thus to get a nimrod
+string from a cstring:
+
+.. code-block:: nimrod
+  var str: string = "Hello!"
+  var cstr: cstring = s
+  var newstr: string = $cstr
+
 
 Structured types
 ----------------