DOC: Enforce Numpy Docstring Validation for pandas.ExcelFile, pandas.ExcelFile.parse and pandas.ExcelWriter #58235
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR is ready for review. Thanks. |
mroeschke
reviewed
Apr 12, 2024
pandas/io/excel/_base.py
Outdated
| 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. |
There was a problem hiding this comment.
Can you copy the text that exists for _shared_docs["storage_options"]
There was a problem hiding this comment.
Fixed in L1443 and L1492. Please review.
There was a problem hiding this comment.
@mroeschke Let me know if I need to improve any other stuff.
mroeschke
approved these changes
Apr 15, 2024
|
Thanks @tuhinsharma121 |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.