Whenever you add a function, method or class please make sure you add a docstring to it, following the numpy conventions. It should at minimum contain a short description of the function/method/class and it's parameters (for functions and methods) or attributes (for classes - __init__ should document both the constructors parameters and the class attributes!), and returns (if applicable) and include at least one example of usage.
Docstrings will be used to automatically generate the API documentation, so please make them as complete as possible! Please go back through old code that you have contributed and document it.
Whenever you add a function, method or class please make sure you add a docstring to it, following the numpy conventions. It should at minimum contain a short description of the function/method/class and it's parameters (for functions and methods) or attributes (for classes -
__init__should document both the constructors parameters and the class attributes!), and returns (if applicable) and include at least one example of usage.Docstrings will be used to automatically generate the API documentation, so please make them as complete as possible! Please go back through old code that you have contributed and document it.