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 some RT02 issues in docstrings #50659

Merged
merged 4 commits into from
Jan 10, 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
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

nice, thanks - can you remove the functions you've fixed from

pandas/ci/code_checks.sh

Lines 86 to 113 in f47a8b8

MSG='Partially validate docstrings (RT02)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT02 --ignore_functions \
pandas.Series.align \
pandas.Series.dt.total_seconds \
pandas.Series.cat.rename_categories \
pandas.Series.cat.reorder_categories \
pandas.Series.cat.add_categories \
pandas.Series.cat.remove_categories \
pandas.Series.cat.remove_unused_categories \
pandas.Index.all \
pandas.Index.any \
pandas.CategoricalIndex.rename_categories \
pandas.CategoricalIndex.reorder_categories \
pandas.CategoricalIndex.add_categories \
pandas.CategoricalIndex.remove_categories \
pandas.CategoricalIndex.remove_unused_categories \
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 \
pandas.DataFrame.align

please?

Merge remote-tracking branch 'upstream/main' into docstrings
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

looks good to me pending green, thanks @DeaMariaLeon

@MarcoGorelli MarcoGorelli added this to the 2.0 milestone Jan 10, 2023
@MarcoGorelli MarcoGorelli merged commit 32b3308 into pandas-dev:main Jan 10, 2023
@DeaMariaLeon DeaMariaLeon deleted the docstrings branch January 11, 2023 09:13
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.

2 participants