Fixed #1123 Add missing Returns section in docstrings

[seanlaw]

See #1123

Pull Request Checklist

Below is a simple checklist but please do not hesitate to ask for assistance!

• Fork, clone, and checkout the newest version of the code
• Create a new branch
• Make necessary code changes
• Install black (i.e., python -m pip install black or conda install -c conda-forge black)
• Install flake8 (i.e., python -m pip install flake8 or conda install -c conda-forge flake8)
• Install pytest-cov (i.e., python -m pip install pytest-cov or conda install -c conda-forge pytest-cov)
• Run black --exclude=".*\.ipynb" --extend-exclude=".venv" --diff ./ in the root stumpy directory
• Run flake8 --extend-exclude=.venv ./ in the root stumpy directory
• Run ./setup.sh dev && ./test.sh in the root stumpy directory
• Reference a Github issue (and create one if one doesn't already exist)

[gitnotebooks]

Review these changes at https://app.gitnotebooks.com/stumpy-dev/stumpy/pull/1124

[seanlaw]

@NimaSarajpoor I don't think I've covered all Returns section to ensure that the text is correct (when it says None but should have a description) but at least docstring.py doesn't complain, which implies that all Parameters also have a corresponding Returns section.

Please review at your earliest convenience.

[NimaSarajpoor]

@seanlaw
Thanks for the PR!! I left two comments. Not relevant directly to this PR but they are related to docstring.py.

[NimaSarajpoor]

@seanlaw
I checked other changed files, and left a few comments to bring your attention to the docstrings that have out1 or out2 as the output variable name (and not out).

[seanlaw]

@NimaSarajpoor I think we might be good now?

[NimaSarajpoor]

@NimaSarajpoor I think we might be good now?

@seanlaw Nothing stands out to me! I think it is ready to be merged. Thanks for the fix!!