What
Add doctests to main code, i.e., interpreter.py
Why:
Provide clear examples of how functions are expected to behave, making the code easier to understand for developers, while validating the correctness of the code by running the examples as tests. This is better than having example notebooks which aren't necessarily run/tested regularly and can become outdated.
How:
Use the notebooks in the example folder as reference and add doctests to functions in interpreter.py
What
Add doctests to main code, i.e., interpreter.py
Why:
Provide clear examples of how functions are expected to behave, making the code easier to understand for developers, while validating the correctness of the code by running the examples as tests. This is better than having example notebooks which aren't necessarily run/tested regularly and can become outdated.
How:
Use the notebooks in the example folder as reference and add doctests to functions in interpreter.py