summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndreas Rumpf <rumpf_a@web.de>2016-09-05 17:07:23 +0200
committerGitHub <noreply@github.com>2016-09-05 17:07:23 +0200
commit19b0df614d3a22ae518ac5ff76a976d5aadf9eaf (patch)
tree1b1320e500254643dc1713399cd6ed35cbaf6a47
parent901e3dbb77695e77e0bbfa47806cec269a9b8870 (diff)
parent4a904d9e57636b48cd5464e23b6b860ed40e5e35 (diff)
downloadNim-19b0df614d3a22ae518ac5ff76a976d5aadf9eaf.tar.gz
Merge pull request #4718 from krux02/cstring-doc
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