SINTEF / pyopia

Python Ocean Particle Image Analysis
https://pyopia.readthedocs.io
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

pipeline class documentation not rendering correctly #274

Closed emlynjdavies closed 5 days ago

emlynjdavies commented 5 days ago

See style guide here

I think pipeline class docstrings should be structured like this:

class SilCamLoad():
    '''PyOpia pipline-compatible class for loading a single silcam image
    using :func:`pyopia.instrument.silcam.load_image`
    and extracting the timestamp using
    :func:`pyopia.instrument.silcam.timestamp_from_filename`

    Parameters
    ----------
    data : :class:`pyopia.pipeline.Data`
        containing the following keys:

        :attr:`pyopia.pipeline.Data.filename`

    Returns
    -------
    data : :class:`pyopia.pipeline.Data`
        containing the following new keys:

        :attr:`pyopia.pipeline.Data.timestamp`

        :attr:`pyopia.pipeline.Data.img`
    '''