[[ Documentation ]] Fixes to ampersand.lcdoc

asayd · montegoulding · commit 12da7ef833ea · 2017-08-16T12:31:49.000+10:00
- Fixed malformed description in params. - Added missing references and removed irrelevant references. - Fixed embedded links. - Added html5 as an OS. - Improved examples. - Removed The result element; operator does not set the result. - Clarified Description. (cherry picked from commit d814d25)
diff --git a/docs/dictionary/operator/ampersand.lcdoc b/docs/dictionary/operator/ampersand.lcdoc
@@ -9,44 +9,43 @@ Summary:
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
 Example:
 put "foo" & "bar" -- evaluates to "foobar"
 
 Example:
-put myVar & return & return into otherVar
+local myVar, otherVar
+put myVar & quote & "hello" & quote into otherVar
 
 Example:
+local theData
 get offset(return & space, theData)
 
 Parameters:
 string1 (string):
-And <string2> are <docRef src="glossary/Values_and/385.xml">literal
-strings</docRef> of <docRef
-src="dictionary/keyword/1485.xml">characters</docRef> (<docRef
-src="glossary/Text_and_D/159.xml">delimited</docRef> with <docRef
-src="glossary/Text_and_D/465.xml">double quotes</docRef>), or <docRef
-src="glossary/Writing_Tr/152.xml">expressions</docRef> that <docRef
-src="glossary/Writing_Tr/104.xml">evaluate</docRef> to <docRef
-src="glossary/Text_and_D/529.xml">strings</docRef>. 
+A <literal string> of <character|characters> (<delimit|delimited> with 
+<double quote|double quotes>), or <expression|expressions> that evaluate 
+to strings. 
 
 string2 (string):
-
-
-The result:
-The result of the  <operator> is a <string> consisting of <string1>
-followed by <string2>.
+A <literal string> of <character|characters> (<delimit|delimited> with 
+<double quote|double quotes>), or <expression|expressions> that evaluate 
+to strings. 
 
 Description:
 Use the & <operator> to create a single <string> out of two or more
-parts. 
+parts. That is, <string2> is appended immediately after <string1> 
+with no intervening space. 
+
 
-References: split (command), quote (constant), string (glossary),
-concatenate (glossary), operator (glossary), \ (keyword),
-string (keyword)
+References: character (glossary), concatenate (glossary), 
+delimit (glossary), double quote (glossary), evaluate (glossary), 
+expression (glossary), literal string (glossary), offset (function), 
+operator (glossary), quote (constant), return (constant), 
+string (glossary)
 
 Tags: text processing
 
