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 comments #17

Open
neonstalwart opened this issue Dec 27, 2011 · 1 comment
Open

add some comments #17

neonstalwart opened this issue Dec 27, 2011 · 1 comment

Comments

@neonstalwart
Copy link
Member

it takes a lot of mental energy to follow some of this code (particularly facet.js). a few more comments might help reduce the effort it takes to follow the logic. i've also been finding (and trying to remember to report) little logic errors or dead pieces of code while trying to understand it, so taking the time to add some comments may find some more of this dead or wrong code.

@neonstalwart
Copy link
Member Author

to clarify... these comments don't need to be as much as a full API reference but just something to help someone reading the code figure out what is being represented by particular variables and what is achieved by certain blocks of code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant