summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorArne Döring <arne.doering@gmx.net>2016-08-13 12:29:36 +0200
committerArne Döring <arne.doering@gmx.net>2016-09-05 15:49:14 +0200
commit4a904d9e57636b48cd5464e23b6b860ed40e5e35 (patch)
treeb8de45b32012cb2a31cb227449106c5753be182c
parent147c2577200306317b5ba52335293a07b6111444 (diff)
downloadNim-4a904d9e57636b48cd5464e23b6b860ed40e5e35.tar.gz
cstring doc
-rw-r--r--doc/manual/types.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/manual/types.txt b/doc/manual/types.txt
index 1e2dc857f..d6495dbc3 100644
--- a/doc/manual/types.txt
+++ b/doc/manual/types.txt
@@ -390,7 +390,10 @@ i-th *unichar*. The iterator ``runes`` from the `unicode module
 
 cstring type
 ------------
-The ``cstring`` type represents a pointer to a zero-terminated char array
+
+The ``cstring`` type meaning `compatible string` is the native representation
+of a string for the compilation backend. For the C backend the ``cstring`` type
+represents a pointer to a zero-terminated char array
 compatible to the type ``char*`` in Ansi C. Its primary purpose lies in easy
 interfacing with C. The index operation ``s[i]`` means the i-th *char* of
 ``s``; however no bounds checking for ``cstring`` is performed making the
@@ -421,7 +424,6 @@ string from a cstring:
   var cstr: cstring = str
   var newstr: string = $cstr
 
-
 Structured types
 ----------------
 A variable of a structured type can hold multiple values at the same