From 3f54575def6cbb9fc905cc476db6d9849545c93b Mon Sep 17 00:00:00 2001
From: macleodbroad-wf <macleodbroad-wf@users.noreply.github.com>
Date: Tue, 8 Aug 2017 14:30:44 -0400
Subject: [PATCH] =?UTF-8?q?Fixes=20Issue=20#3316=20-=20Updates=20network?=
 =?UTF-8?q?=20documentation=20to=20account=20for=20edge=E2=80=A6=20(#3319)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Fixes Issue #3316 - Updates network documentation to account for edge-case of how clusterByConnection uses the joinCondition callback

* Move the text 'clusterByConnection will pass ... callback.' to under 'Optional for all but the cluster method'.
Make it clear that clusterByConnection is the only one that uses the second call.
Instead of bold, make it a distinct paragraph.
---
 docs/network/index.html | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/docs/network/index.html b/docs/network/index.html
index 7a438717..01af8ad0 100644
--- a/docs/network/index.html
+++ b/docs/network/index.html
@@ -1193,9 +1193,11 @@ function releaseFunction (clusterPosition, containedNodesPositions) {
                 <th>Type</th>
                 <th>Description</th>
             </tr>
-            <tr><td>joinCondition(<br>&nbsp;&nbsp;<code>nodeOptions:&nbsp;Object</code><br>)</td>
+            <tr><td>joinCondition(<br>&nbsp;&nbsp;<code>nodeOptions:&nbsp;Object</code><br>)<br>or<br>joinCondition(<br>&nbsp;&nbsp;<code>parentNodeOptions:&nbsp;Object,</code><br>&nbsp;&nbsp;<code>childNodeOptions:&nbsp;Object</code><br>)</td>
                 <td>Function</td>
-                <td><i>Optional for all but the cluster method. </i> The cluster module loops over all nodes that are
+                <td><i>Optional for all but the cluster method. </i> <br>
+                    <code>clusterByConnection</code> is the only function that will pass 2 nodeOptions objects as arguments to the joinCondition callback.<br>
+                    The cluster module loops over all nodes that are
                     selected to be in the cluster and calls this function with their data as argument.
                     If this function returns true, this node will be added to the cluster. You have access to all
                     options
@@ -1219,6 +1221,7 @@ var options = {
 
 network.clustering.cluster(options);
 </pre>
+                    <code>clusterByConnection</code><b> will pass 2 nodeOptions objects as arguments to the joinCondition callback.</b>
                 </td>
             </tr>
             <tr><td>processProperties(<br>&nbsp;&nbsp;<code>clusterOptions:&nbsp;Object</code>,<br>