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: fix PR02 errors in docstrings - pandas.core.window.rolling.Rolling.quantile, pandas.core.window.expanding.Expanding.quantile #57211

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

jordan-d-murphy
Copy link
Contributor

All PR02 Errors resolved in the following cases:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.core.window.rolling.Rolling.quantile
  2. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.core.window.expanding.Expanding.quantile

OUTPUT:

  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.core.window.rolling.Rolling.quantile
################################################################################
################################## Validation ##################################
################################################################################

5 Errors found for `pandas.core.window.rolling.Rolling.quantile`:
	ES01	No extended summary found
	SA05	pandas.Series.rolling in `See Also` section does not need `pandas` prefix, use Series.rolling instead.
	SA05	pandas.DataFrame.rolling in `See Also` section does not need `pandas` prefix, use DataFrame.rolling instead.
	SA05	pandas.Series.quantile in `See Also` section does not need `pandas` prefix, use Series.quantile instead.
	SA05	pandas.DataFrame.quantile in `See Also` section does not need `pandas` prefix, use DataFrame.quantile instead.
  1. scripts/validate_docstrings.py --format=actions --errors=PR02 pandas.core.window.expanding.Expanding.quantile
################################################################################
################################## Validation ##################################
################################################################################

5 Errors found for `pandas.core.window.expanding.Expanding.quantile`:
	ES01	No extended summary found
	SA05	pandas.Series.expanding in `See Also` section does not need `pandas` prefix, use Series.expanding instead.
	SA05	pandas.DataFrame.expanding in `See Also` section does not need `pandas` prefix, use DataFrame.expanding instead.
	SA05	pandas.Series.quantile in `See Also` section does not need `pandas` prefix, use Series.quantile instead.
	SA05	pandas.DataFrame.quantile in `See Also` section does not need `pandas` prefix, use DataFrame.quantile instead.

…ng.quantile, pandas.core.window.expanding.Expanding.quantile
@datapythonista datapythonista merged commit 70f47ee into pandas-dev:main Feb 2, 2024
57 checks passed
@datapythonista
Copy link
Member

Thanks @jordan-d-murphy, nice update

@mroeschke mroeschke added this to the 3.0 milestone Feb 2, 2024
@jordan-d-murphy jordan-d-murphy deleted the issue#57111_4 branch February 2, 2024 17:59
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
…ng.quantile, pandas.core.window.expanding.Expanding.quantile (pandas-dev#57211)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants