Skip to content

Commit

Permalink
Add REVIEW comments, see #123
Browse files Browse the repository at this point in the history
  • Loading branch information
samreid committed May 14, 2024
1 parent 0c4e357 commit 8e5f06e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
4 changes: 4 additions & 0 deletions js/buoyancy/model/BoatDesign.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
* compute a shape (for a given block size) such that in 2D it "acts" as the proper 3d shape. This is mainly due to
* the block corners pressing against the inside of the boat's hull.
*
* REVIEW: https://github.com/phetsims/density-buoyancy-common/issues/123 This file is > 800 lines of complicated code
* with many magic numbers. We should make an effort to remove unused parts, and clean up where possible.
*
* @author Jonathan Olson <[email protected]>
*/

Expand Down Expand Up @@ -727,6 +730,7 @@ BoatDesign.ONE_LITER_HULL_VOLUME = BoatDesign.DESIGN_HULL_VOLUME * BoatDesign.ON

/**
* Replaces the main page with a debug view of the bottle, for debugging various curves and properties.
* REVIEW: https://github.com/phetsims/density-buoyancy-common/issues/123 this is unused and also says "bottle"
*
* phet.densityBuoyancyCommon.BoatDesign.getDebugCanvas()
*/
Expand Down
3 changes: 3 additions & 0 deletions js/buoyancy/model/Bottle.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
* the tip to the saddle point (second curve).
* - Saddle point: The true mathematical saddle where the saddle/tip curves meet back up, at r=0
*
* REVIEW: https://github.com/phetsims/density-buoyancy-common/issues/123 This file is > 1200 lines of complicated code
* with many magic numbers. We should make an effort to remove unused parts, and clean up where possible.
*
* Diagram in x,r coordinates, showing the "profile" (exactly half of the bottle, and the curves that the
* three-dimensional form will be made from):
*
Expand Down

0 comments on commit 8e5f06e

Please sign in to comment.