Skip to content

Commit

Permalink
improve comments and code style, see #93
Browse files Browse the repository at this point in the history
  • Loading branch information
jbphet committed Feb 14, 2025
1 parent 2bff059 commit 98cf8dc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 6 additions & 5 deletions js/photons/model/PhotonCollection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ export class PhotonCollection extends PhetioObject {
}

/**
* For serialization, the PhotonCollectionIO uses reference type serialization. That is, each PhotonCollection exists for the life of the
* simulation, and when we save the state of the simulation, we save the current state of the PhotonCollection.
* For serialization, the PhotonCollectionIO uses reference type serialization. That is, each PhotonCollection exists
* for the life of the simulation, and when we save the state of the simulation, we save the current state of the
* PhotonCollection.
*
* The PhotonCollection serves as a composite container of PhotonIO instances. The Photons are serialized using data-type serialization.
* For deserialization, the Photons are deserialized (again, using data-type serialization) and applied to the
* PhotonCollection in its applyState method.
* The PhotonCollection serves as a composite container of PhotonIO instances. The Photons are serialized using
* data-type serialization. For deserialization, the Photons are deserialized (again, using data-type serialization)
* and applied to the PhotonCollection in its applyState method.
*
* Please see https://github.com/phetsims/phet-io/blob/main/doc/phet-io-instrumentation-technical-guide.md#serialization
* for more information on the different serialization types.
Expand Down
4 changes: 2 additions & 2 deletions js/photons/model/PhotonsExperimentSceneModel.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Copyright 2024-2025, University of Colorado Boulder

/**
* PhotonsExperimentSceneModel is the class that defines the model for each of the two scenes in the "Photons" screen, one for the
* single-photon experiment and one for the multi-photon experiment.
* PhotonsExperimentSceneModel is the class that defines the model for each of the two scenes in the "Photons" screen,
* one for the single-photon experiment and one for the multi-photon experiment.
*
* @author John Blanco, PhET Interactive Simulations
*/
Expand Down

0 comments on commit 98cf8dc

Please sign in to comment.