search

choderalab / software-development

A primer on software development best practices for computational chemistry
255 stars 76 forks source link

Python coding best practices #23

Closed andrrizzi closed 7 years ago

andrrizzi commented 7 years ago

Fixes #10 . Ready for review.

I kept this as a general Python introduction article which refers to the testing and documentation tutorials (@gregoryross and @bas-rustenburg). I kept the OOP design discussion for a separate article since it's somewhat more advanced. I'll write this next week.

I'd like feedback particularly on the Find bugs before they find you section, where I compiled a list of patterns that can mask bugs. Are there some I should add/remove?

andrrizzi commented 7 years ago

Done! Feel free to merge if the section about editors sounds good enough.