Closed samreid closed 6 years ago
@samreid I took a stab at this in the above commits, please review. If there is more to do, don't tell me what to change. Instead just say, "You're missing something" so I can attempt to find it myself first 😄.
Also please ignore the changes to package.json
in 054565d8725429740230f41041f9eb3c1fc946cf (the first commit). That was a mistake that was reverted.
Looks great @phet-steele, some minor recommendations:
@author
on the files you changed.* Control panel constructor.
is redundant and should be removed (also the blank line after it)I hardly feel like I should be the author in any of these, but I especially don't think I should be in ExampleScreen.js
. I added myself as author to all but that file.
@samreid recommendations have been done in the above commits. Please review and close!
Excellent work, thanks! Closing.
We use example-sim as a reference in test tasks, and it should be brought up to our new level of standards as other sims according to the https://github.com/phetsims/phet-info/blob/master/checklists/code_review_checklist.md
Issues in particular that need to be addressed:
@public
,@private
, etc.For example, Bar Magnet's
size
property should get a comment like:And BarMagnet's reset function should get JSDoc like: