arrow icon indicating copy to clipboard operation
arrow copied to clipboard

ARROW-15006: [Python][CI][Doc] Enable numpydoc check PR03

Open amoeba opened this issue 3 years ago • 6 comments

Adds an additional numypdoc check to CI (PR03) and fixes all corresponding violations.

This includes one minor breaking change to parameter order in pyarrow.parquet.read_table which makes order more uniform across ParquetDataset.__new__, read_table, and read_pandas which have related signatures.

Note this does not fully resolve ARROW-15006.

amoeba avatar Aug 27 '22 01:08 amoeba

https://issues.apache.org/jira/browse/ARROW-15006

github-actions[bot] avatar Aug 27 '22 01:08 github-actions[bot]

:warning: Ticket has not been started in JIRA, please click 'Start Progress'.

github-actions[bot] avatar Aug 27 '22 01:08 github-actions[bot]

Thanks for reviewing this @jorisvandenbossche. I took your suggestion on keeping skip_rows and skip_rows_after_names together. I re-ran archery numpydoc --allow-rule PR03 which still passes. This is ready for another look.

amoeba avatar Aug 29 '22 22:08 amoeba

Thanks @jorisvandenbossche, the conflict should now be resolved. I made an attempt at addressing your comment so let me know if that's what you were thinking. This is ready for another look when you have time.

amoeba avatar Sep 14 '22 20:09 amoeba

Ping @jorisvandenbossche: Any chance you have a spare moment to take a look at this again? Thanks!

amoeba avatar Sep 28 '22 20:09 amoeba

Sorry for the noise, I was cleaning up my fork and wiped out the commits. They've since been restored and this is ready for review.

amoeba avatar Oct 12 '22 01:10 amoeba

Thanks for the review @jorisvandenbossche. I didn't mean to remove that bit and I'm not sure how I did. Good catch! All three instances of that param docstring now have the expected text.

Ready for review/merge.

amoeba avatar Oct 19 '22 21:10 amoeba