-
Notifications
You must be signed in to change notification settings - Fork 3
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
insufficient documentation for calls to link, addListener, etc. #156
Comments
Closed
SaurabhTotey
pushed a commit
that referenced
this issue
Aug 28, 2019
SaurabhTotey
pushed a commit
that referenced
this issue
Aug 28, 2019
I tried finding all missing comments, but it is possible that I may have missed a few. Assigning to @pixelzoom to review. |
pixelzoom
added a commit
that referenced
this issue
Aug 31, 2019
@SaurabhTotey I found a few more in the above commit. Feel free to close after reviewing. |
It all seems good to me. Closing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For this item in code review #143:
I inspected all occurrences of "link(". Sometimes there's a comment, e.g. in CurveFittingModel:
But many times there's no information about whether unlink is needed or not, or why. E.g. in CurveFittingModel:
There's also no description of the sim's general policy in implementation-notes.md, which would make such comments unnecessary when they conform to that policy. E.g. something like "all Properties exist for the lifetime of the sim and don't need to be unlinked unless otherwise noted in code comments".
I also inspected DerivedProperty instantiations, and there's no info about whether they need to be dispose and why.
Ditto for Emitter addListener.
So there's some work to be done here, documenting which registrations need or don't need to be unregistered.
The text was updated successfully, but these errors were encountered: