Browse Source

Network: Fix documentation for event `stabilized` (#3582)

Fixes #3468.

Rather than changing the code, this resolves the issue by adjusting the documentation for event `stabilized`.
mbroad/code-climate-coverage-develop
wimrijnders 7 years ago
committed by Yotam Berkowitz
parent
commit
3c48a38db5
1 changed files with 1 additions and 1 deletions
  1. +1
    -1
      docs/network/index.html

+ 1
- 1
docs/network/index.html View File

@ -1487,7 +1487,7 @@ Thus, to get the topmost item, get the value at index 0.
</td>
<tr><td id="event_stabilized">stabilized</td>
<td>Object</td>
<td>Fired when the network has stabilized or when the <code>stopSimulation()</code> has been called. The amount of iterations it took could be used to tweak the maximum amount of iterations needed to stabilize the network. Passes an object with properties structured as:
<td>Fired when the network has stabilized, when the amount of iterations defined in the options has been reached, or when the <code>stopSimulation()</code> has been called. The amount of iterations it took could be used to tweak the maximum amount of iterations needed to stabilize the network. Passes an object with properties structured as:
<pre class="prettyprint lang-js">{
iterations: Number // iterations it took
}</pre>

Loading…
Cancel
Save