dask / dask/distributed

Update docstring style

Open
#3,578 3 comments 0 reactions 0 assignees View on GitHub
documentation good first issue
Dominant language
Python
Stars
1.7k
Forks
778
Avg merge
2h 50m
Merged PRs (30d)
3

Description

Not all of our docstrings totally conform to the recommended [`numpydoc` formatting](https://numpydoc.readthedocs.io/en/latest/format.html#sections). For example in `Client.gather`

https://github.com/dask/distributed/blob/806a7e97285c5534b3e37e912cbc060a8036c56f/distributed/client.py#L1855-L1858

the description of the returned value should be on a new line which is indented. We should go through our docstrings and update them to be in line with the `numpydoc` specification.

xref #3530

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.