Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Documentation #44

Merged
merged 1 commit into from Nov 17, 2012

Conversation

Projects
None yet
2 participants

ltvolks commented Oct 7, 2012

This is just an initial go at documenting the source after skimming. Mostly trivial notes, but the idea would be to lay the groundwork for more detail by someone more familiar with the code. When you start to review the code there are a few obtuse variable names that make it harder to reason about what's going on, and the length of some of the functions makes it more difficult to get a sense of what the purpose is at a glance.

You can also run docco over the source now and get a decent html overview.

Ref: Issue 43

@taitems taitems added a commit that referenced this pull request Nov 17, 2012

@taitems taitems Merge pull request #44 from ltvolks/master
Documentation
2675ce2

@taitems taitems merged commit 2675ce2 into taitems:master Nov 17, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment