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 #135

Closed
Tracked by #129
veillette opened this issue Jul 27, 2021 · 8 comments
Closed
Tracked by #129

implementation-notes.md #135

veillette opened this issue Jul 27, 2021 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation status:ready-for-review

Comments

@veillette
Copy link
Contributor

veillette commented Jul 27, 2021

From the CRC:

  • Does implementation-notes.md adequately describe the implementation, with an overview that will be useful to future maintainers?

See https://github.com/phetsims/geometric-optics/blob/master/doc/implementation-notes.md

@veillette
Copy link
Contributor Author

I added to the implementation node before the code review although there is surely more confusing aspect of the similation that could be fleshed out.

@veillette veillette added the documentation Improvements or additions to documentation label Jul 31, 2021
@zepumph
Copy link
Member

zepumph commented Aug 4, 2021

Note some formatting done in 276d32b

@zepumph
Copy link
Member

zepumph commented Aug 4, 2021

I added to the implementation node before the code review although there is surely more confusing aspect of the similation that could be fleshed out.

Honestly. I thought that was a very intelligently written implementation notes markdown. It helped get me up to speed quite well on the physics and code structure. Up to you how much more you would like to flesh out.

@pixelzoom
Copy link
Contributor

I make another pass through this later, to note any changes that I make.

@pixelzoom pixelzoom changed the title Does implementation-notes.md adequately describe the implementation, with an overview that will be useful to future maintainers? implementation-notes.md Sep 22, 2021
@pixelzoom
Copy link
Contributor

See #196 (comment) for terminology used in the code. This should be used to revise implementation-notes.md.

@pixelzoom
Copy link
Contributor

implementation-notes.md is ready for review by whoever does the sim code review.

@pixelzoom
Copy link
Contributor

pixelzoom commented Apr 6, 2022

@jonathanolson Please review as part of code review #402.

@jonathanolson
Copy link
Contributor

Implementation and model notes are excellent! Thank you.

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

4 participants