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

Documentation improvements #18

Open
pstjvn opened this issue Dec 8, 2012 · 0 comments
Open

Documentation improvements #18

pstjvn opened this issue Dec 8, 2012 · 0 comments

Comments

@pstjvn
Copy link

pstjvn commented Dec 8, 2012

I like very much the idea behind your work and I used parts of the framework, however based on my experience with closure library for the last 2 years I find for myself that the best way to understand how to use something is to read its code and documenting comments. What I see in your work is mostly annotations for the compiler and very little information on the actual methods and the idea behind them, let alone description of why a certain method is working the way it is. Most recent example for me is the placeChild_ property that is marked with underscore (while not strictly a compiler directive (i.e. missing private tag) underscore usually indicates private members) it is unclear how to use it nor how to set it. At least setter method should have been provided (if it should be really considered a private member) and description on how it is supposed to be used.

I would really love to see more descriptive and helpful comments in the code, this will greatly reduce the time it takes for a closure developer to get used to your work.

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

1 participant