search

AguaClara / UASB

AguaClara's wastewater team devoted to creating sustainable wastewater treatment in under-served communities
14 stars 13 forks source link

Add Doctests to Design Functions #86

Open IanCullings opened 6 years ago

IanCullings commented 6 years ago

To ensure our code works the way we expect, and to add documentation, we should implement doctests on all functions in the design manual and summer report. This tutorial details this process, and there are many examples on the Spring report.

@ananya-gangadhar @isakaminsky this could be a good project for both of you to practice python and become more familiar with the functions we're working with, since Zac and I have written most of the code so far. Ideally this will be done by Friday to include in the report.

IanCullings commented 6 years ago

@ananya-gangadhar if you have free time this week but you can't come in, this would be a great thing to work on! Most of the functions still don't have doctests