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

implementation-note.md #260

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

implementation-note.md #260

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

Comments

@marlitas
Copy link
Contributor

Implementation-notes.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 changed the title implementation-note.ms implementation-note.md May 29, 2024
@marlitas marlitas mentioned this issue May 29, 2024
81 tasks
marlitas added a commit to phetsims/soccer-common that referenced this issue Jun 4, 2024
@marlitas
Copy link
Contributor Author

marlitas commented Jun 4, 2024

I gave this an initial stab and I think it's ready for some additional eyes and editing. Over to @jbphet

@jbphet
Copy link
Contributor

jbphet commented Jun 5, 2024

Looks very good to me! Please review the very minor edits I made with my commits and the suggestions I have below.

Suggestions:

  • There is some inconsistency in the writing around whether to refer to "the mean" or "mean". I'm more accustomed to the former, but I don't know whether one is considered more correct. I poked around a bit online and it seemed to me that both are used but "the mean" is perhaps a bit more common.
  • I added some more about the use of the terms "table" and "notepad" in the code, please review and make sure we're good with this.

@jbphet jbphet assigned marlitas and unassigned jbphet Jun 5, 2024
@marlitas marlitas mentioned this issue Jun 7, 2024
81 tasks
@marlitas
Copy link
Contributor Author

marlitas commented Jun 7, 2024

I think the edits you made are good! I think this is in a good. I'll go ahead and close this as complete :-)

@marlitas marlitas closed this as completed Jun 7, 2024
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

2 participants