core: update doc of `CString`

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

diff --git a/lib/core/text/abstract_text.nit b/lib/core/text/abstract_text.nit
index 71021ab..ba667df 100644 (file)
--- a/lib/core/text/abstract_text.nit
+++ b/lib/core/text/abstract_text.nit
@@ -1268,9 +1268,9 @@ end
 abstract class FlatText
        super Text
 
-       # Underlying C-String (`char*`)
+       # Underlying CString (`char*`)
        #
-       # Warning : Might be void in some subclasses, be sure to check
+       # Warning: Might be void in some subclasses, be sure to check
        # if set before using it.
        var items: CString is noinit
 

diff --git a/lib/core/text/native.nit b/lib/core/text/native.nit
index f7c803b..0ff3787 100644 (file)
--- a/lib/core/text/native.nit
+++ b/lib/core/text/native.nit
@@ -83,12 +83,14 @@ redef class Int
        end
 end
 
-# Native strings are simple C char *
+# C string `char *`
+#
+# Used as underlying implementation for `String` and some other `Text`.
 extern class CString `{ char* `}
-       # Creates a new CString with a capacity of `length`
+       # Create a new `CString` with the capacity for `length` characters
        new(length: Int) is intern
 
-       # Returns a char* starting at `index`.
+       # Get a char* starting at `index`.
        #
        # WARNING: Unsafe for extern code, use only for temporary
        # pointer manipulation purposes (e.g. write to file or such)