-
-
Notifications
You must be signed in to change notification settings - Fork 19.4k
DOC: inline docstrings for read_excel and storage options in io/excel… #63193
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
base: main
Are you sure you want to change the base?
Conversation
…/base.py. with Ruff formatting fixes
rhshadrach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
pandas/io/excel/_base.py
Outdated
| storage_options : dict, optional | ||
| Extra options that make sense for a particular storage connection, e.g. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this and the two instance below, can you indent the body description as is done for other parameters.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely, sorry I got busy and am just now getting back to work on the failing checks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have updated this as asked for, I am still failing two checks, but I am unsure why, I copied the docstrings as suggested originally and I have only made linting and requested changes since then, any advice would be appreciated!
rhshadrach
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's just an indentation issue.
pandas/io/excel/_base.py
Outdated
| If used in conjunction with ``parse_dates``, will parse dates according to this | ||
| format. For anything more complex, | ||
| please read in as ``object`` and then apply :func:`to_datetime` as-needed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs indenting
Removed usage of the
@Appenderand@docdecorators for read_excel and storage_options, replacing them with inline docstrings for pandas/io/excel/_base.py.doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.