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

Model.md #259

Closed
marlitas opened this issue May 23, 2024 · 5 comments
Closed

Model.md #259

marlitas opened this issue May 23, 2024 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation status:ready-for-review

Comments

@marlitas
Copy link
Contributor

The model.md needs to be written and reviewed prior to code review

@marlitas marlitas added the documentation Improvements or additions to documentation label May 23, 2024
@marlitas marlitas mentioned this issue May 29, 2024
81 tasks
marlitas added a commit that referenced this issue Jun 4, 2024
@marlitas
Copy link
Contributor Author

marlitas commented Jun 4, 2024

I did a first pass at this. Would be good to get eyes on it from @amanda-phet and @jbphet

@jbphet
Copy link
Contributor

jbphet commented Jun 5, 2024

This is very nice as far as I'm concerned. It's well structured, clearly written, and seems to be add an appropriate level of detail. I made a few, mostly quite minor, edits in the commits above and have a few suggestions below.

Suggestions

  • Consider mentioning somewhere that the "real world" representation is at the bottom of the screen and the "notepad" representation is at the top.
  • I didn't quite understand what was being conveyed by the phrase, "a cup will add on with an open pipe", so I wasn't sure how to edit it to make it clearer, so I'll just say that you might want to wordsmith that part a bit.
  • I modified the phrase "with [the balance beam] becoming completely level when the data set is evenly distributed across the beam" to "...completely level when the data set is equally distributed on the left and right sides of the fulcrum". Feel free to modify it further, I just thought it didn't quite convey what was going on as written.

@jbphet jbphet assigned marlitas and unassigned jbphet Jun 5, 2024
@marlitas marlitas mentioned this issue Jun 7, 2024
81 tasks
marlitas added a commit that referenced this issue Jun 9, 2024
@marlitas
Copy link
Contributor Author

marlitas commented Jun 9, 2024

I went ahead and addressed the above. All that remains is review from @amanda-phet.

@marlitas marlitas removed their assignment Jun 9, 2024
amanda-phet added a commit that referenced this issue Jun 10, 2024
@amanda-phet
Copy link
Contributor

I made a lot of changes, so it might be good to review again. @marlitas will you let me know if my changes are ok?

@amanda-phet amanda-phet assigned marlitas and unassigned amanda-phet Jun 10, 2024
marlitas added a commit that referenced this issue Jun 11, 2024
@marlitas
Copy link
Contributor Author

The changes look great! Thank you. I updated the author credit to include you @amanda-phet. I think this is ready to close but feel free to re-open if not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation status:ready-for-review
Projects
None yet
Development

No branches or pull requests

3 participants