search

Clinical-Genomics / GeneLists

Scripts to automate the handling of gene lists
0 stars 1 forks source link

Initial code review #1

Closed robinandeer closed 10 years ago

robinandeer commented 10 years ago

I thought I would do a spontaneous code review. I picked this repo mainly since it's implemented in Python.

I will suggest improvements according to best practices and conventions used at Clinical Genomics.

robinandeer commented 10 years ago

Improvement The README should be updated with more details on what is included in the repo.

It would be nice with an introduction to each of the scripts in the repository. What it does, how you use it, and basic I/O.

robinandeer commented 10 years ago

Improvement I notice that you decided to create a separate repo for this project. I think that's a good idea but would suggest that if it grows further, you might want to think about turning into a proper package that is easier to distribute and install.

It will make maintenance, collaboration, testing etc. much easier as well.

This is the starting point I use: https://github.com/robinandeer/cookiecutter-pyvanguard

robinandeer commented 10 years ago

Suggestion I like to write my docstrings according to the Google style guides. It makes the inline docs much more readable.

You can find out more and see example: http://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html

ingkebil commented 10 years ago

Packaging is for when I add support for OMIM and genenames.org ;)

Thanks for the review! If that's all for now, I'm gonna merge the pull.

ingkebil commented 10 years ago

Well, I didn't really close this, I just merged this into master.

robinandeer commented 10 years ago

Don't worry about it :+1: