Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enum improvements #305

Closed
samreid opened this issue Jan 8, 2019 · 6 comments
Closed

Enum improvements #305

samreid opened this issue Jan 8, 2019 · 6 comments

Comments

@samreid
Copy link
Member

samreid commented Jan 8, 2019

Let's follow the proposal in phetsims/phet-core#53 and reassign to @pixelzoom when ready.

@samreid samreid self-assigned this Jan 8, 2019
@samreid
Copy link
Member Author

samreid commented Jan 8, 2019

I moved to this pattern for DisturbanceType in this commit d538c9d, @pixelzoom would you mind doing a micro-review before I continue?

Also, I noted that unfortunately WebStorm doesn't know how to highlight this too well and is showing a lot of gray underlines:

image

@pixelzoom
Copy link
Contributor

Looks good to me.

@samreid
Copy link
Member Author

samreid commented Jan 9, 2019

I fixed up the other enums, @pixelzoom can you please review? Close if all is well.

@pixelzoom
Copy link
Contributor

pixelzoom commented Jan 9, 2019

Enumerations look great. Questions about a few related fields:

(1) Should this field in Scene be documented as "read-only"?

// @public {WaveSpatialType}
this.waveSpatialType = ...

(2) I wonder if this Property in SoundScene might be better named soundViewTypeProperty, since it's value is of type SoundViewType.

      // @public - indicates the selected view for sound
      this.viewSelectionProperty = new Property( SoundScene.SoundViewType.WAVES, {
        validValues: SoundScene.SoundViewType.VALUES
      } );

(3) Similarly in DiffractionModel, I wonder if this Property might be better named apertureTypeProperty:

      // @public - selected scene
      this.sceneProperty = new Property( DiffractionModel.ApertureType.CIRCLE, {
        validValues: DiffractionModel.ApertureType.VALUES
      } );

@samreid
Copy link
Member Author

samreid commented Jan 11, 2019

Thanks, I followed your recommendations, ready for review.

@samreid samreid assigned pixelzoom and unassigned samreid Jan 11, 2019
@pixelzoom
Copy link
Contributor

👍 Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants