DataFrame.rolling documentation of method='table'

[joshlk]

• closes DOC: Rolling with method="table" to apply func to all columns and not just individual columns #40374
• tests added / passed
• Ensure all linting tests pass, see here for how to run them

[pep8speaks]

Hello @joshlk! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file pandas/core/window/rolling.py:

Line 1615:9: E122 continuation line missing indentation or outdented
Line 1619:1: W293 blank line contains whitespace
Line 1628:1: W293 blank line contains whitespace
Line 1638:1: W293 blank line contains whitespace

Comment last updated at 2021-04-14 11:10:21 UTC

[mzeitlin11]

Thanks for the pr, @joshlk! A couple quick suggestions

[mroeschke]

This might be better in the rolling apply docstring (as many of these parameters are specific to apply)

[joshlk]

The doc example is primarily about how to use the method='table' feature in the rolling function. Also the apply doc currently doesn't include any examples - all the examples seem to be in the rolling doc (e.g. .sum(std=3))

[mroeschke]

Right but this particular usage of method='table' feature in the rolling function is only specific to rolling(...).apply(...).

The apply doc could definitely use more examples!

[joshlk]

Would you like me to move this to the apply docstring?

[mroeschke]

Yes, this example you made would go great in the rolling apply docstring

[joshlk]

@mroeschke Hi, I've tried adding the docs to the apply doc-string but I'm unsure how to do it - my latest commit isn't working. Sorry I am unfamiliar with how the doc-string is being generated.

[mroeschke]

You can see in this CI check what modifications need to be made to get this check to pass: https://github.com/pandas-dev/pandas/pull/40519/checks?check_run_id=2342425934

Additionally you can see here how to render the docs locally to see if there's inconsistent formatting somewhere: https://pandas.pydata.org/pandas-docs/dev/development/contributing_documentation.html#building-the-documentation

[simonjayhawkins]

@joshlk ci is failing can you fix-up

[joshlk]

@joshlk ci is failing can you fix-up

Hi, I've tried adding the docs to the apply doc-string but I'm unsure how to do it - my latest commit isn't working. Sorry I am unfamiliar with how the doc-string is being generated. Could you please help

[simonjayhawkins]

you can run the docstring validation script locally. (if on windows use git bash or wsl)

to build the docs, see https://pandas.pydata.org/pandas-docs/dev/development/contributing_documentation.html#building-the-documentation

this PR is also failing pre-commit checks (black and trailing whitespace) see https://pandas.pydata.org/pandas-docs/dev/development/contributing_codebase.html#pre-commit

[datapythonista]

@joshlk can you have a look at the points of the previous comment, and try to leave the CI green please?

[Flix6x]

I get a TypeError: unhashable type: 'dict' when I run this line. When I replace {{ with { and }} with } it works, though.

[mroeschke]

Thanks for the PR, but appears that progress has stalled. Closing, but let us know if you're still interested in working on this and we'd be happy to reopen.