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

Peer review of code #4

Open
kdea020 opened this issue Oct 4, 2016 · 0 comments
Open

Peer review of code #4

kdea020 opened this issue Oct 4, 2016 · 0 comments

Comments

@kdea020
Copy link

kdea020 commented Oct 4, 2016

  • Overall, your code is very clean and nicely grouped into discrete functions that handle individual tasks.
  • Commenting is quite sparse, but I found most lines to be simple and understandable without further explanation (others' mileage may vary). However, you may wish to provide commentary for some of the more complex parts of the script, such as the create_network functions (especially the last one that has the for loop, since that's got quite a sophisticated chain of contingencies).
  • Could be worth commenting the purpose and source of the modules you are using in your import section (for clarity and so others can make sure they have the necessary modules required to run the script).
  • It would also be valuable to have, in your notebook, examples of input (for your queries) and output for some of the query functions earlier in the script.
  • Great code and wish I could test it out!
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