Skip to content

DOC: fix EX03 errors in docstrings - pandas.io.formats.style.Styler: highlight_quantile, background_gradient, text_gradient #56904

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

Merged
merged 4 commits into from
Jan 16, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All EX03 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.highlight_quantile
  2. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.background_gradient
  3. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.text_gradient

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.highlight_quantile
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.io.formats.style.Styler.highlight_quantile`:
	RT03	Return value has no description
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.background_gradient
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.io.formats.style.Styler.background_gradient`:
	RT03	Return value has no description
  1. scripts/validate_docstrings.py --format=actions --errors=EX03 pandas.io.formats.style.Styler.text_gradient
################################################################################
################################## Validation ##################################
################################################################################

1 Errors found for `pandas.io.formats.style.Styler.text_gradient`:
	RT03	Return value has no description

…highlight_quantile, background_gradient, text_gradient
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Looks great, we'll have to wait for the CI again, as this has now a conflict.

@mroeschke mroeschke added this to the 3.0 milestone Jan 16, 2024
@mroeschke mroeschke merged commit 327af12 into pandas-dev:main Jan 16, 2024
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

@jordan-d-murphy jordan-d-murphy deleted the issue#56804_11 branch January 16, 2024 19:33
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
…highlight_quantile, background_gradient, text_gradient (pandas-dev#56904)

DOC: fix EX03 errors in docstrings -  pandas.io.formats.style.Styler:  highlight_quantile, background_gradient, text_gradient

Co-authored-by: Marc Garcia <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants