Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Doc Strings in parser.py #988

Open
anishnya opened this issue Jun 10, 2021 · 5 comments · May be fixed by #1010
Open

Improve Doc Strings in parser.py #988

anishnya opened this issue Jun 10, 2021 · 5 comments · May be fixed by #1010
Labels
documentation good first issue
Projects
Release 1.2.0

Comments

@anishnya
Copy link
Member

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 anishnya changed the title Improve Doc String in parser.py Improve Doc Strings in parser.py Jun 10, 2021
@anishnya anishnya added this to To do in Release 1.2.0 Jun 24, 2021
@izhun
Copy link

izhun commented Jul 29, 2021

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

@anishnya
Copy link
Member Author

@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.

@krisfremen krisfremen linked a pull request Aug 2, 2021 that will close this issue
Draft
5 tasks
@krisfremen
Copy link
Member

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

@anishnya anishnya moved this from To do to In progress in Release 1.2.0 Aug 2, 2021
@gh-adithya
Copy link

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

@krisfremen
Copy link
Member

@gh-adithya yes, it's open.

I had #1010 as a draft PR a while back, you can continue off of that if you'd like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue
Projects
No open projects
Release 1.2.0
In progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding docstrings to parser.py (#988) krisfremen/arrow
4 participants
@krisfremen @izhun @anishnya @gh-adithya