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-notes.md #264

Closed
pixelzoom opened this issue Mar 8, 2023 · 7 comments
Closed

implementation-notes.md #264

pixelzoom opened this issue Mar 8, 2023 · 7 comments
Assignees

Comments

@pixelzoom
Copy link
Contributor

pixelzoom commented Mar 8, 2023

For #262.

Link: https://github.com/phetsims/calculus-grapher/blob/master/doc/implementation-notes.md

This would be nice to have before official code review, but not essential. Certainly we should have it done before @veillette's sabbatical ends.

This was referenced Mar 8, 2023
@veillette
Copy link
Contributor

I'll assign this one to myself.

@veillette
Copy link
Contributor

Assigning to @pixelzoom as well.

veillette added a commit that referenced this issue Mar 18, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
replace duplicate doc of query parameters with a link to CalculusGrapherQueryParameters, #264
@pixelzoom
Copy link
Contributor Author

The section titled Query Parameters duplicated the information in CalculusGrapherQueryParameters.ts, and would be likely to get out of sync. Since dev and QA are used to reading query-parameter schemas, I replaced that section with a link to CalculusGrapherQueryParameters.ts.

pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 19, 2023
@pixelzoom
Copy link
Contributor Author

I added a Termninology section that needs to be fleshed out. I think we can keep this very brief. No need to include general math terminology, only sim-specific terms that might not be obvious, and would help someone reading the code.

veillette added a commit that referenced this issue Mar 19, 2023
pixelzoom added a commit that referenced this issue Mar 20, 2023
veillette added a commit that referenced this issue Mar 23, 2023
Signed-off-by: Martin Veillette <[email protected]>
veillette added a commit that referenced this issue Mar 24, 2023
veillette added a commit that referenced this issue Mar 27, 2023
Signed-off-by: Martin Veillette <[email protected]>
veillette added a commit that referenced this issue Mar 27, 2023
Signed-off-by: Martin Veillette <[email protected]>
veillette added a commit that referenced this issue Mar 27, 2023
Signed-off-by: Martin Veillette <[email protected]>
veillette added a commit that referenced this issue Mar 27, 2023
@veillette
Copy link
Contributor

I added a section about PHET-IO with a short stub. Assigning to @pixelzoom who be able to add something more cogent/relevant.

veillette added a commit that referenced this issue Mar 28, 2023
Signed-off-by: Martin Veillette <[email protected]>
@pixelzoom
Copy link
Contributor Author

implementation-notes.md is not delivered with a release. So we can continue to make changes after the release branch is published, and there's no need to cherry-pick to the release branch.

@veillette
Copy link
Contributor

I went over the implementations-notes. It is a good description and if we compare it to other sim's implementations-notes, we are raising the bar. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants