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

Encouraging doctesting #261

Open
WPennock opened this issue Jan 24, 2020 · 3 comments
Open

Encouraging doctesting #261

WPennock opened this issue Jan 24, 2020 · 3 comments
Labels
feature Feature request/addition low Low priority

Comments

@WPennock
Copy link
Collaborator

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.

@WPennock WPennock added low Low priority feature Feature request/addition labels Jan 24, 2020
@HannahSi
Copy link
Member

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
Copy link
Collaborator Author

WPennock commented Feb 18, 2020

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
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature request/addition low Low priority
Projects
None yet
Development

No branches or pull requests

3 participants