Merge pull request livecode#4930 from asayd/patch-18

peter-b · web-flow · commit 2262603b9abc · 2016-12-01T14:15:26.000Z
[[ Documentation ]] Changes to slash.lcdoc
diff --git a/docs/dictionary/operator/slash.lcdoc b/docs/dictionary/operator/slash.lcdoc
@@ -2,23 +2,25 @@ Name: /
 
 Type: operator
 
-Syntax: <number> /divisor
+Syntax: <dividend> / <divisor>
 
 Summary:
-Divides one number by another number.
+Divides one number by another number or one array by another array.
 
 Introduced: 1.0
 
-OS: mac, windows, linux, ios, android
+OS: mac, windows, linux, ios, android, html5
 
 Platforms: desktop, server, mobile
 
 Example:
 # Dividing a literal number by another
+local approxPi
 put 22/7 into approxPi -- approximates pi
 
 Example:
 # Dividing two variables
+local thisVariable
 get thisVariable/(thisVariable + 1)
 
 Example:
@@ -30,38 +32,47 @@ put 10 into tDivisorArray[1]
 put 5 into tDivisorArray[2]
 put tNumberArray / tDivisorArray into tDividedArray
 put tDividedArray[1] & comma & tDividedArray[2]
-# The result is 1,4
+# Yields 1,4
 
 Parameters:
-number:
-The operands number and divisor are numbers, or expressions that
-evaluate to numbers, or arrays containing numbers.
+dividend:
+A number or an expression that
+evaluates to a number, or an array containing numbers.
+
+divisor:
+A number or an expression that
+evaluates to a number, or an array containing numbers.
 
 Description:
 Use the </> (divide) <operator> to divide one number by another.
 
+> *Note:* When used in complex arithmetic statements, 
+<operator|operators> like </> follows standard rules of <precedence>.
+
 To divide the contents of a container by a number, use the <divide>
 <command> instead.
 
-If <number> is an <array>, each of the <array>
+If <dividend> or <divisor> is an <array>, each of the <array>
 <element(glossary)|elements> must be a number. If an <array> is divided
 by a number, each <element(keyword)> is divided by the number. If an
 <array> is divided by an <array>, both <array|arrays> must have the same
 number of <element(glossary)|elements> and the same dimension, and each
 <element(keyword)> in one <array> is divided by the corresponding
 <element(keyword)> of the other <array>.
 
-If an element of an array is empty, the </> <operator> treats its
+If an element of an array is empty, the </> <operator> treats its 
 contents as zero.
 
-Attempting to divide by zero causes an execution error.
+> *Important:* Attempting to divide by zero causes an execution error.
+
 
 Changes:
 The option to divide arrays was introduced in version 1.1. In previous
 versions, only single numbers could be used with the / operator.
 
 References: divide (command), operator (glossary), array (glossary),
-command (glossary), element (glossary), element (keyword), div (operator),
+command (glossary), element (glossary), element (keyword), 
+div (operator), precedence (glossary), 
 mod (operator), * (operator), wrap (operator)
 
 Tags: math
