Developing Information

Doc strings

The old proposed way to document pyOpTools was confusing and should not be used any more. From now on all the documentation should be written in the NumPy Style Python Docstrings. This style was chosen because it allows to easily document function and methods with multiple return values (return tuples).

See also: https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

Creating Surface Subclasses

The following care must be taken when creating a Surface subclass:

  1. All surfaces super classes must be picklable. To do this follow:
    1. All subclasses inherit from pyoptools.picklable.picklable.Picklable
    2. For cython subclasses register all the attributes that affect the state using self.addkey(“key”)
      where key is changed by the attribute key.
    3. For python subclasses nothing needs to be done