search

SINTEF / pyopia

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

Some docstrings not rendering multiple return arguments correctly #264

Closed emlynjdavies closed 6 days ago

emlynjdavies commented 1 week ago

This thread seems to describe this issue:

https://github.com/sphinx-doc/sphinx/issues/9119

emlynjdavies commented 1 week ago

Example:

This works:

Parameters
    ----------
    stats : DataFrame
        particle statistics from silcam process
    pix_size : float
        pixel size in microns

    Returns
    -------
    dias : array
        mid-points of size bins
    vd : array
        volume distribution in micro-litres/sample-volume

This doesn't

Args:
        stats (DataFrame)           : particle statistics from silcam process
        pix_size (float)            : pixel size in microns

Returns:
    dias                        : mid-points of size bins
    vd                          : volume distribution in micro-litres/sample-volume