Skip to content
This repository has been archived by the owner on Jul 29, 2019. It is now read-only.

Documentation issue for joinCondition + clusterByConnection #3316

Closed
CiaranG opened this issue Jul 30, 2017 · 1 comment
Closed

Documentation issue for joinCondition + clusterByConnection #3316

CiaranG opened this issue Jul 30, 2017 · 1 comment

Comments

@CiaranG
Copy link

CiaranG commented Jul 30, 2017

When clustering network nodes, the various cluster functions all take an options object which includes a joinCondition callback. This is documented (docs/network) as receiving a single nodeOptions parameter. That's true for most of the cluster functions, but not for clusterByConnection where it receives two - one for the parent node and one for the actual candidate (child) node.

@wimrijnders
Copy link
Contributor

Confirmed. Well spotted. We'll put someone on this to fix it.

macleodbroad-wf pushed a commit to macleodbroad-wf/vis that referenced this issue Jul 30, 2017
…or edge-case of how clusterByConnection uses the joinCondition callback
yotamberk pushed a commit that referenced this issue Aug 8, 2017
#3319)

* 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.
primozs pushed a commit to primozs/vis that referenced this issue Jan 3, 2019
…or edge… (almende#3319)

* Fixes Issue almende#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.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants