DOC: Fix the docstring of resample in pandas/core/generic.py

[datapythonista]

pandas docstring are expected to follow the format defined in https://pandas.pydata.org/pandas-docs/stable/contributing_docstring.html

This includes among other things:

• There is a short description fitting in one line (there can be a longer one after that).
• The description of the parameters, the returns section, and the see also items, starts with a capital letter and ends with a period.
• In the Return section there is no name before the type (e.g. transformed : Series) but just the type (e.g. Series) in the first line.
• The examples are valid PEP-8 code, and when executed, they produce the shown input.

We should make the required adjustments in the docstring of the function resample in pandas/core/generic.py.

We should validate the docstring with our validator (which does not validate all the formats, but some):

• ./scripts/validate_docstrings.py pandas.Series.resample

And we should validate the PEP-8 of the examples (note that the next command will validate the PEP-8 of all examples, just make sure that none of the shown is in the function being addressed, the rest will be fixed in separate issues):

• flake8 --doctests pandas/core/generic.py

[tonytao2012]

I can work on this!
Edit: I am no longer working on this. Sorry!

[martharobinson]

I would like to work on this

[datapythonista]

Great, let us know if you need help @martharobinson

Now we've got few PRs from others that can help you, as they are quite similar: #22902, #22890, #22904 and #22906

[jmrr]

Hey @datapythonista as the last person who volunteered didn't eventually open a PR I took a stab at this and made good progress during the London Python Sprints Hacktoberfest meetup, hope I didn't break any pandas etiquette here.

I have a question. The validate_docstrings script produces errors with deprecated parameters, e.g. Parameters {fill_method, limit, how} not documented. What is the policy with these parameters?

Thanks!

[datapythonista]

In some cases it may make sense to ping the last person who said would be working on it. But an issue to fix a docstring with no activity for two weeks seems like available to me too.

Deprecated parameters should be documented and have the sphinx directive for deprecations.

[martharobinson]

Yes, sorry life intervened and prevented me from finishing this! Sorry for not making that clear.