Our API¶
I made this little project so people could easily fork, update the name and author, enable a few web hooks, and have a project which had well defined testing, documentation, code linting and more.
Here is the docstring from the __init__.py file. In this file, it is good practise to define
__all__ so that anyone running import * gets the right content!
It is also good for removing unnecessary filenames. If you read the __init__.py file, you can see that
someone could now run from some_module import add_stuff instead of
having to run from some_module.code import integrate_trapz.
Also note that members without documentation (such as untested_subtract do not appear in the doco).