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 comments to code based on feedback #137

Closed
gliechtenstein opened this issue Jul 5, 2017 · 2 comments
Closed

Add comments to code based on feedback #137

gliechtenstein opened this issue Jul 5, 2017 · 2 comments

Comments

@gliechtenstein
Copy link
Contributor

This library has an unconventional architecture. And the code initially had near 0 annotation. This made it difficult to understand what's going on.

So I have started adding comments https://github.com/intercellular/cell/blob/develop/cell.js

I would love to improve it, so please let me know if there are parts that are unclear and I'll update or add more comments.

@piranna
Copy link

piranna commented Jul 5, 2017

Could you stick them to 80 columns so they are easier to read? :-)

@gliechtenstein
Copy link
Contributor Author

@piranna I had actually started updating the code to reflect your feedback but the code became too long, and the functions became too far from one another separated by long paragraphs of comments.

I think each option has pros and cons. Too many lines of code makes it hard to get a quick birds eye view of the code. Also it's good to have comments but having too many lines of code gives the impression that the code is more complex than it actually is (humans are irrational beings).

I'm going to just stash the changes I've made so far, but if many people want this option I'll think about it. Thanks for the feedback!

This was referenced Jul 5, 2017
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

2 participants