From 2d429e75ce69e77f8c95490ac03881ec9aa0354a Mon Sep 17 00:00:00 2001
From: Marti Bolivar <mbolivar@mit.edu>
Date: Mon, 25 Oct 2010 21:15:28 -0400
Subject: arduino language reference nearing completion, properly CC-BY-SA 3.0
 attributed

---
 source/arduino/min.rst | 50 +++++++++++++++++++++-----------------------------
 1 file changed, 21 insertions(+), 29 deletions(-)

(limited to 'source/arduino/min.rst')

diff --git a/source/arduino/min.rst b/source/arduino/min.rst
index fdd7a5f..0ac018c 100644
--- a/source/arduino/min.rst
+++ b/source/arduino/min.rst
@@ -1,3 +1,5 @@
+.. highlight:: cpp
+
 .. _arduino-min:
 
 min(x, y)
@@ -6,19 +8,16 @@ min(x, y)
 Description
 -----------
 
-Calculates the minimum of two numbers.
+(Macro) Calculates the minimum of two numbers.
 
 
 
 Parameters
 ----------
 
-x: the first number, any data type
-
-
-
-y: the second number, any data type
+**x**: the first number; may be any number or numeric expression.
 
+**y**: the second number; may be any number or numeric expression.
 
 
 Returns
@@ -27,45 +26,38 @@ Returns
 The smaller of the two numbers.
 
 
-
-Examples
---------
+Example
+-------
 
 ::
 
     sensVal = min(sensVal, 100); // assigns sensVal to the smaller of sensVal or 100
                                  // ensuring that it never gets above 100.
 
-Note
-----
-
-Perhaps counter-intuitively, max() is often used to constrain the
-lower end of a variable's range, while min() is used to constrain
-the upper end of the range.
 
+.. note:: Perhaps counter-intuitively, max() is often used to
+   constrain the lower end of a variable's range, while min() is used
+   to constrain the upper end of the range.
 
 
 Warning
 -------
 
-Because of the way the min() function is implemented, avoid using
-other functions inside the brackets, it may lead to incorrect
-results
-
-
-
-::
+Because of the way ``min()`` is implemented, avoid using other
+functions inside the parentheses. It may lead to incorrect results::
 
     min(a++, 100);   // avoid this - yields incorrect results
-    
-    a++;
-    min(a, 100);    // use this instead - keep other math outside the function
 
+    a++;            // use this instead -
+    min(a, 100);    // keep other operations outside min()
 
+Arduino Compatibility
+---------------------
 
-See also
---------
+The Maple version of ``min()`` is compatible with Arduino.
 
+See Also
+--------
 
--  `max <http://arduino.cc/en/Reference/Max>`_\ ()
--  `constrain <http://arduino.cc/en/Reference/Constrain>`_\ ()
+-  :ref:`max() <arduino-max>`
+-  :ref:`constrain() <arduino-constrain>`
-- 
cgit v1.2.3