-
Notifications
You must be signed in to change notification settings - Fork 4
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 doc needs fleshing out #308
Comments
As I review the code, I'm seeing the terms "antecedent" and "consequent" used a lot. It would be good to mention these as important terms in the implementation-notes document and say a bit about how they are used in this context, or perhaps provide a good link. I vaguely recall the terms, but am in the process of searching online to refresh my memory about them, so some good docs might save time for future devs. |
Yes, I had an incorrect understanding of the separation of model.md and implementation_notes.md, as so those are defined briefly in model.md, Most of model.md will end up moving to implementation notes. |
I basically merged all of model.md into the implementation notes. @jbphet please let me know if you recommend anything else here, and feel free to close. |
Looks good, this is a big improvement. I have a few comments:
|
Thank you for your suggestions. That was very helpful! Closing |
From the code review in #286, specifically the item "Does implementation-notes.md adequately describe the implementation, with an overview that will be useful to future maintainers?".
The document as currently written is quite brief and jumps right into some very specific information without describing the overall architecture and design approach. It also doesn't describe any of the key classes or the relationships between them. I think pulling the information from
model.md
into this document would help (see #307), and providing a good "forest for the trees" sort of explanation as well.The text was updated successfully, but these errors were encountered: