From 8e5f06e081d91a9fa1430eb6130d041d4e8d119a Mon Sep 17 00:00:00 2001 From: Sam Reid Date: Mon, 13 May 2024 20:31:59 -0600 Subject: [PATCH] Add REVIEW comments, see https://github.com/phetsims/density-buoyancy-common/issues/123 --- js/buoyancy/model/BoatDesign.ts | 4 ++++ js/buoyancy/model/Bottle.ts | 3 +++ 2 files changed, 7 insertions(+) diff --git a/js/buoyancy/model/BoatDesign.ts b/js/buoyancy/model/BoatDesign.ts index 7de9c469..4563b43b 100644 --- a/js/buoyancy/model/BoatDesign.ts +++ b/js/buoyancy/model/BoatDesign.ts @@ -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 */ @@ -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() */ diff --git a/js/buoyancy/model/Bottle.ts b/js/buoyancy/model/Bottle.ts index ed4c154d..50854a7b 100644 --- a/js/buoyancy/model/Bottle.ts +++ b/js/buoyancy/model/Bottle.ts @@ -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): *