Skip to content

DOC: New storage_options for read_csv needs a docstring #36361

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.

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

Closed
Dr-Irv opened this issue Sep 14, 2020 · 2 comments · Fixed by #36364
Closed

DOC: New storage_options for read_csv needs a docstring #36361

Dr-Irv opened this issue Sep 14, 2020 · 2 comments · Fixed by #36364

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Sep 14, 2020

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.read_csv.html

Documentation problem

The new storage_options keyword for read_csv and read_table is not documented in the docstring.

Suggested fix for documentation

Add docstring

@martindurant

NOTE: I noticed this when running validate_docstrings locally for read_csv and it reported this.

@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 14, 2020
@ghost
Copy link

ghost commented Sep 14, 2020

What this keyword is used for @Dr-Irv
I could fix the docstring, which would help me understand the contribution process for pandas.

@Dr-Irv Dr-Irv added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 14, 2020
@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Sep 14, 2020

@kshivi99 If you look at files common.py, feather_format.py, parquet.py, pickle.py, stata.py, in the directory pandas/io, you can just copy the docstring from there.

Just be really careful to do validate_docstrings on the changed file to make sure it will render OK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant