From 82f3fff6721fe00ce4282fc5ff30838055a545bd Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sun, 31 May 2020 09:22:46 -0400
Subject: [PATCH] improve documentation for adaline

---
 machine_learning/adaline_learning.cpp | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/machine_learning/adaline_learning.cpp b/machine_learning/adaline_learning.cpp
index a484e27aa..055c3b776 100644
--- a/machine_learning/adaline_learning.cpp
+++ b/machine_learning/adaline_learning.cpp
@@ -266,6 +266,10 @@ void test2(double eta = 0.01) {
  * sphere of radius 1 and centre at origin as +1 and others as -1. Note that
  * each point is defined by 3 values but we use 6 features. The function will
  * create random sample points for training and test purposes.
+ * The sphere centred at origin and radius 1 is defined as:
+ * \f$x^2+y^2+z^2=r^2=1\f$ and if the \f$r^2<1\f$, point lies within the sphere
+ * else, outside.
+ *
  * \param[in] eta learning rate (optional, default=0.01)
  */
 void test3(double eta = 0.01) {