arrow icon indicating copy to clipboard operation
arrow copied to clipboard
verified publisher icon arrow-py

Improve Doc Strings in parser.py

Open anishnya opened this issue 4 years ago • 6 comments

Issue Description

I think we should improve the doc strings in parser.py to be more descriptive and similar like the rest of Arrow.

anishnya avatar Jun 10 '21 03:06 anishnya

@anishnya Could you please concrete the rest of Arrow? What module or class can be used as reference?

izhun avatar Jul 29 '21 16:07 izhun

@izhun So for example arrow.py, we use the rest (see rest here for a more detailed explanation https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format) doc string format. We would like to see the doc strings in parser.py use the same format.

anishnya avatar Jul 30 '21 02:07 anishnya

@anishnya hey, I've started on this, first pass, opened up a draft PR for now

krisfremen avatar Aug 02 '21 03:08 krisfremen

Hi! Is this issue still open? I would like to work on this issue as my first contribution for this project.

gh-adithya avatar Oct 19 '23 18:10 gh-adithya

@gh-adithya yes, it's open.

I had https://github.com/arrow-py/arrow/pull/1010 as a draft PR a while back, you can continue off of that if you'd like.

krisfremen avatar Oct 20 '23 01:10 krisfremen