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 copious comments for new programmers in the source code #4

Open
ntoll opened this issue Apr 8, 2016 · 2 comments
Open

Add copious comments for new programmers in the source code #4

ntoll opened this issue Apr 8, 2016 · 2 comments

Comments

@ntoll
Copy link

ntoll commented Apr 8, 2016

As a new programmer who has just found their feet with Python and network zero I'd like to be able to look at the source and understand (at a high level) how it works. I can't stress how important it is that we foster the attitude of autonomous and autodidactic research. ;-)

I'm happy to help with this effort.

@tjguk
Copy link
Owner

tjguk commented Apr 8, 2016

Very much up for this, @ntoll. I'd wait a little because I'm still moving some of the pieces around (especially after several people last night pointed out that getaddrinfo on Linux works quite differently from under Windows!). But I'm definitely +1 on the idea and I'll try to add commenting in as I go.

@ntoll
Copy link
Author

ntoll commented Apr 8, 2016

Exactly! I imagine the next few weeks will involved some refactoring to get towards a 0.9 version - at which point documentation and code commenting would be a useful thing to do to get it over the line for 1.0. :-)

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