API docs missing for read_csv, read_fwf and read_table

[fjetter]

I believe there are still plenty of doc strings missing since the dask-expr migration

For example https://docs.dask.org/en/latest/generated/dask_expr.read_csv.html

[joehiggi1758]

Hello @fjetter - hope you're having a wonderful day!

I'd love to assist here - this would be my first ever PR, how should I help update these doc strings (aka is there a template I can follow)?

Would love to help!

[fjetter]

A couple of things here.

First of all, this issue is actually a bit more work than I initially anticipated. A while ago we migrated to a new dataframe backend using https://github.com/dask/dask-expr
We had to move over a couple of different doc strings, see for example dask/dask-expr#1051. These doc strings should also has to be added in that repo.

The original docs for read_csv, read_fwf and read_table where actually auto generated using a template, see
READ_DOC_TEMPLATE

I suspect we can use the same template but will require a slightly different mechanism. I suspect adding

read_csv.__doc__ = READ_DOC_TEMPLATE.format(reader="read_csv", file_type="CSV")

and similar for FWF and table should do the trick. (See here where the legacy readers are defined)

[joehiggi1758]

@fjetter sounds great I'll take a crack at it!