Skip to content

Commit

Permalink
Add documentation, see #103
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed Mar 27, 2024
1 parent c503836 commit 9ce5568
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion js/common/model/Electron.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ export default class Electron {
private readonly currentAmplitudeProperty: TReadOnlyProperty<number>;
private readonly currentAmplitudeRange: Range;

// Electron's position, relative to the coil's position
// Electron's position, relative to the coil's position. This value is changed internally and should not be changed by
// clients. Also be aware that the entire Vector2 may be changed (rather than just the x and y values changing).
public position: Vector2;

// Ordered collection of the segments that make up the coil
Expand Down

0 comments on commit 9ce5568

Please sign in to comment.