follow nim-lang#8463 nim-lang#14157 and document cstring literals

ringabout · Nov 7, 2020 · 2ad6b96 · timotheecour · Nov 7, 2020 · timotheecour
1 parent fa5f225
commit 2ad6b96
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/manual.rst b/doc/manual.rst
@@ -1282,6 +1282,13 @@ string from a cstring:
   var cstr: cstring = str
   var newstr: string = $cstr
 
+You shouldn't modify cstring literals. Otherwise unexpected situations may happen.
+
+.. code-block:: nim
+  # this is wrong!!!
+  var x = cstring"literals"
+  x[1] = 'A'
+
 Structured types
 ----------------
 A variable of a structured type can hold multiple values at the same