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

Add some code documentation #14

Open
ameshkov opened this issue Apr 19, 2018 · 0 comments
Open

Add some code documentation #14

ameshkov opened this issue Apr 19, 2018 · 0 comments
Assignees

Comments

@ameshkov
Copy link
Member

ameshkov commented Apr 19, 2018

I'd appreciate if you add a comment in the file head describing the logic starting from the entry point (DeepOverrideHost.addProperty) and briefly explaining the algorithm.

Something like this:

  1. The entry point -- addProperty, accepts this and that parameter
  2. Then we're building the object state tree for the given path (buildAbstractStateTree)
  3. Using this tree we're applying the object state and override necessary properties (applyObjectState)
  4. Etc, etc

This will greatly help the reader to understand the code.

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