arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed

1 files changed, 39 insertions, 0 deletions

diff --git a/docs/source/arduino/sq.rst b/docs/source/arduino/sq.rst
new file mode 100644
index 0000000..2b6b1fe
--- /dev/null
+++ b/docs/source/arduino/sq.rst
@@ -0,0 +1,39 @@
+.. highlight:: cpp
+
+.. _arduino-sq:
+
+sq(a)
+=====
+
+Description
+-----------
+
+(Macro) computes the square of a number.
+
+Parameters
+----------
+
+**a**: the number.
+
+Returns
+-------
+
+**a** squared (**a** × **a**).
+
+Warning
+-------
+
+Because of the way ``sq()`` is implemented, avoid using other
+functions or causing side effects inside the parentheses, as it may
+lead to incorrect results::
+
+    b = sq(a++);   // avoid this - yields incorrect results
+
+    b = sq(a);     // use this instead -
+    a++;           // keep other operations outside sq()
+
+
+Arduino Compatibility
+---------------------
+
+Maple's implementation of ``sq()`` is compatible with Arduino.