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.

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

DOC: Enforce Numpy Docstring Validation for pandas.ExcelFile, pandas.ExcelFile.parse and pandas.ExcelWriter #58235

Merged
merged 6 commits into from
Apr 15, 2024

Conversation

tuhinsharma121
Copy link
Contributor

@tuhinsharma121
Copy link
Contributor Author

This PR is ready for review. Thanks.

Please do not report issues when using ``xlrd`` to read ``.xlsx`` files.
This is not supported, switch to using ``openpyxl`` instead.
storage_options : StorageOptions
Passed to _get_filepath_or_buffer.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you copy the text that exists for _shared_docs["storage_options"]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in L1443 and L1492. Please review.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mroeschke Let me know if I need to improve any other stuff.

@mroeschke mroeschke added the Docs label Apr 12, 2024
@rhshadrach rhshadrach added the IO Excel read_excel, to_excel label Apr 13, 2024
@mroeschke mroeschke added this to the 3.0 milestone Apr 15, 2024
@mroeschke mroeschke merged commit a64ff48 into pandas-dev:main Apr 15, 2024
50 checks passed
@mroeschke
Copy link
Member

Thanks @tuhinsharma121

@tuhinsharma121 tuhinsharma121 deleted the numpy-docstring-excelfile branch April 15, 2024 18:27
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
…ExcelFile.parse and pandas.ExcelWriter (pandas-dev#58235)

* fixed docstring for pandas.ExcelFile

* fixed docstring for pandas.ExcelFile.parse

* fixed docstring for pandas.ExcelWriter

* removed methods pandas.ExcelFile, pandas.ExcelFile.parse and pandas.ExcelWriter

* fixed E501 Line too long for pandas.ExcelFile.parse

* used storage_options definition from _shared_docs[storage_options]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Excel read_excel, to_excel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants