DOC: fix docstring validation errors for pandas.io.formats.style.Styler #59607
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
1 task
mroeschke
requested changes
Aug 26, 2024
pandas/io/formats/style.py
Outdated
| @@ -553,11 +576,11 @@ def to_excel( | |||
| startcol: int = 0, | |||
| engine: str | None = None, | |||
| merge_cells: ExcelWriterMergeCells = True, | |||
| encoding: str | None = None, | |||
There was a problem hiding this comment.
The ordering of these parameters should not change.
There was a problem hiding this comment.
This function's parameters are out of order when used in the base to_excel template docstring (since var extra_parameters is substituted at its end). I'll roll back the current change and instead add optional params to the base to_excel template docstring to accommodate encoding and verbose.
There was a problem hiding this comment.
Resolution for requested change is in 175dd36.
….style.Styler.to_excel
hlakams
force-pushed
the
fix_docstring_pandas_styler
branch
from
6eb9be1 to
175dd36
Compare
mroeschke
approved these changes
Aug 27, 2024
|
Thanks @hlakams |
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.
Addresses #59606.
Fixes:
pandas/ci/code_checks.sh
Lines 308 to 335 in 360597c
Note: order of args for
pandas.io.formats.style.Styler.to_excelshifted around in order to maintain compatibility with shared doc template handler.