[[ StdMlc ]] Update typeconvert docs

runrevali · runrevali · commit fc09d1a8d76e · 2014-12-10T11:51:42.000Z
diff --git a/libscript/src/type-convert.mlc b/libscript/src/type-convert.mlc
@@ -1,5 +1,5 @@
 /* 
-This module specifies the syntax for the complex type conversion operations available in modular LiveCode 
+This library consists of the operations for performing complex type conversion in modular LiveCode 
 */
 
 module com.livecode.typeconvert
@@ -11,15 +11,22 @@ public foreign handler MCTypeConvertExecCombineListWithDelimiter(in Target as li
 
 /*
 Summary:        Splits the string in <Target> into a list of strings, using <Delimiter>
-                as the delimiter. After execution, the container <Target> is a list.
+                as the delimiter.
 
 Target:         An expression that evaluates to a string container.
 Delimiter:      An expression that evaluates to a string.
 
 Example:
-            put "first,second,third,fourth,fifth" into tVar
-            split tVar by ","
-            put element 1 of tVar into tFirstElement // tFirstElement contains "first"
+	variable tVar as string
+    put "first,second,third,fourth,fifth" into tVar
+    variable tSplit as list
+    split tVar by "," into tSplit
+    put element 1 of tSplit into tFirstElement // tFirstElement contains "first"
+    
+Description:
+Use the split command to convert a string representation of a list into a genuine (ordered) list.
+
+Tags: Type conversion
 */
 
 syntax StringSplitBy is statement
@@ -30,16 +37,24 @@ end syntax
 
 /*
 Summary:        Combines the list of strings in <Target>, using <Delimiter>
-                as the delimiter. After execution, the container <Target> is a string.
-
+                as the delimiter. 
+                
 Target:         An expression that evaluates to a list container.
 Delimiter:      An expression that evaluates to a string.
 
 Example:
-            repeat with tDigit = 1 to 9
-                put tDigit as string into element tDigit of tList
-            end repeat
-            combine tList with "," // tList contains "1,2,3,4,5,6,7,8,9"
+	variable tDigits as list
+	put [1,2,3,4,5,6,7,8,9] into tDigits
+	
+	variable tString as string
+    combine tDigits with "|" into tString // tString contains "1|2|3|4|5|6|7|8|9"
+            
+Description:
+Use the combine command to convert a list into a string representation of the list.
+
+>*Note:* The list *must* consist entirely of string elements, otherwise the combine command will throw an error.
+
+Tags: Type conversion
 */
 
 syntax CombineListWith is statement
