search

phetsims / plinko-probability

"Plinko Probability" is an educational simulation in HTML5, by PhET Interactive Simulations.
GNU General Public License v3.0
6 stars 7 forks source link

Update ballStep documentation #35

Closed jessegreenberg closed 8 years ago

jessegreenberg commented 8 years ago

JSDoc documentation for 'ballStep' is only partially correct, and is actually the documentation for updatePosition. In addition to updating the position, the ballStep function also updates peg information and emits events. Since this is such an important function for this sim, so would you mind describing what full purpose in the JSDoc?

veillette commented 8 years ago

@memo330179 did most of the work on the position and the ballStep. I'm assigning it to you.

memo330179 commented 8 years ago

I've added the documentation with the responsibilities the step function has. I tried to be descriptive, but not clutter the JSDoc.

jessegreenberg commented 8 years ago

Thanks @memo330179! Looks great.