Skip to content

Commit

Permalink
Update documentation about the Coil ends, see #122
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Mar 27, 2024
1 parent 46e61b3 commit cfd8972
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions js/common/model/Coil.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
* Coil is the model of a coil of wire, with a current flowing through it.
*
* The coil is described as an array of CoilSegment, which form a set of loops which are not connected at the ends.
* The ends of the coil are where things can be connected to the coil (eg, lightbulb, voltmeter, power supply).
* The ends of the coil are short wire segments (also implemented by CoilSegment) where things can be connected to the
* coil (eg, lightbulb, voltmeter, power supply). You can easily visualize the ends by changing their stroke color in
* createCoilSegments.
*
* The CoilSegments describe the coil's shape, and the path that electrons follow as they flow through the coil,
* move between layers (foreground or background), and adjust ("scale") their speed so that they appear to flow
Expand Down Expand Up @@ -42,7 +44,6 @@ import Emitter from '../../../../axon/js/Emitter.js';
const ELECTRON_SPACING = 25;

// Ends of the coil contain a fixed number of electrons.
// REVIEW - What is considered an 'end'? CM: Is "Ends of the coil" immediately above not clear enough?
const ELECTRONS_IN_LEFT_END = 2;
const ELECTRONS_IN_RIGHT_END = 2;

Expand Down

0 comments on commit cfd8972

Please sign in to comment.