Skip to content

DOC: Fix some RT02 issues in docstrings #50785

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 9 commits into from
Jan 18, 2023

Conversation

DeaMariaLeon
Copy link
Member

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

Towards #49968

Merge remote-tracking branch 'upstream/main' into docstrings
Merge remote-tracking branch 'upstream/main' into docstrings
Merge remote-tracking branch 'upstream/main' into docstrings
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.

Thanks for the clean up @DeaMariaLeon, looks good. Just a minor comment, not sure if it's affecting the execution or not.

pandas.Index.all \
pandas.Index.any \
pandas.MultiIndex.drop \
pandas.DatetimeIndex.to_pydatetime \
pandas.TimedeltaIndex.to_pytimedelta \
pandas.core.groupby.SeriesGroupBy.apply \
pandas.core.groupby.DataFrameGroupBy.apply \
pandas.io.formats.style.Styler.export \
pandas.api.extensions.ExtensionArray.astype \
pandas.api.extensions.ExtensionArray.dropna \
pandas.api.extensions.ExtensionArray.isna \
pandas.api.extensions.ExtensionArray.repeat \
pandas.api.extensions.ExtensionArray.unique \
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
pandas.api.extensions.ExtensionArray.unique \
pandas.api.extensions.ExtensionArray.unique

I think you need to remove the backslash here, since this is the last in the list now

@MarcoGorelli
Copy link
Member

thanks for working on this!

looks like there's still some errors:

 Error: /home/runner/work/pandas/pandas/pandas/core/frame.py:4923:RT02:pandas.DataFrame.align:The first line of the Returns section should contain only the type, unless multiple values are being returned
Error: /home/runner/work/pandas/pandas/pandas/core/series.py:4643:RT02:pandas.Series.align:The first line of the Returns section should contain only the type, unless multiple values are being returned
Error: /home/runner/work/pandas/pandas/pandas/core/accessor.py:95:RT02:pandas.Series.dt.total_seconds:The first line of the Returns section should contain only the type, unless multiple values are being returned

Merge remote-tracking branch 'upstream/main' into docstrings
@mroeschke mroeschke added this to the 2.0 milestone Jan 18, 2023
@mroeschke mroeschke merged commit fc627fa into pandas-dev:main Jan 18, 2023
@mroeschke
Copy link
Member

Thanks @DeaMariaLeon

@DeaMariaLeon DeaMariaLeon deleted the docstrings branch January 19, 2023 08:56
@DeaMariaLeon
Copy link
Member Author

Thank you!

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.

4 participants