AguaClara / aguaclara

An open-source Python package for designing and performing research on AguaClara water treatment plants.
https://aguaclara.github.io/aguaclara/
MIT License
24 stars 13 forks source link

Encouraging doctesting #261

Open WPennock opened 4 years ago

WPennock commented 4 years ago

Since the tutorial says that doctest should be used for all coding by AguaClara subteams, including import doctest in this might help set the expectation that doctesting is essential.

HannahSi commented 4 years ago

Hi William, by tutorial, do you mean this AguaClara Tutorial page? And would you be able clarify where it would be helpful to include import doctest?

WPennock commented 4 years ago

Hi William, by tutorial, do you mean this AguaClara Tutorial page? And would you be able clarify where it would be helpful to include import doctest?

Hi, Hannah; I'm sorry that was unclear. What I meant was that it could perhaps be included in aguaclara.play so that the doctest package would be loaded by default for most AguaClara coding projects.

oliver-leung commented 4 years ago

I feel that it might not be necessary to include import doctest in our __init__.py file (this has replaced aguaclara.play in that users now run import aguaclara as ac to import these functions), but we can consider adding it as an "install_requires" package in setup.py.