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.

Sign up for GitHub

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

Jump to bottom

DOC: fix RT03 errors in docstrings #57416

Closed
jordan-d-murphy opened this issue Feb 14, 2024 · 18 comments
Closed

DOC: fix RT03 errors in docstrings #57416

jordan-d-murphy opened this issue Feb 14, 2024 · 18 comments
Labels
Docs good first issue

Comments

@jordan-d-murphy
Copy link
Contributor

Pandas has a script for validating docstrings:

pandas/ci/code_checks.sh

Lines 144 to 414 in 44c50b2

MSG='Partially validate docstrings (RT03)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT03 --ignore_functions \
pandas.Index.to_numpy\
pandas.Categorical.set_categories\
pandas.CategoricalIndex.set_categories\
pandas.DataFrame.astype\
pandas.DataFrame.at_time\
pandas.DataFrame.ewm\
pandas.DataFrame.expanding\
pandas.DataFrame.filter\
pandas.DataFrame.first_valid_index\
pandas.DataFrame.get\
pandas.DataFrame.hist\
pandas.DataFrame.infer_objects\
pandas.DataFrame.kurt\
pandas.DataFrame.kurtosis\
pandas.DataFrame.last_valid_index\
pandas.DataFrame.mask\
pandas.DataFrame.max\
pandas.DataFrame.mean\
pandas.DataFrame.median\
pandas.DataFrame.min\
pandas.DataFrame.nsmallest\
pandas.DataFrame.nunique\
pandas.DataFrame.pipe\
pandas.DataFrame.plot.box\
pandas.DataFrame.plot.density\
pandas.DataFrame.plot.kde\
pandas.DataFrame.plot.scatter\
pandas.DataFrame.pop\
pandas.DataFrame.prod\
pandas.DataFrame.product\
pandas.DataFrame.reindex\
pandas.DataFrame.reorder_levels\
pandas.DataFrame.sem\
pandas.DataFrame.skew\
pandas.DataFrame.std\
pandas.DataFrame.sum\
pandas.DataFrame.swapaxes\
pandas.DataFrame.to_numpy\
pandas.DataFrame.to_orc\
pandas.DataFrame.to_parquet\
pandas.DataFrame.unstack\
pandas.DataFrame.value_counts\
pandas.DataFrame.var\
pandas.DataFrame.where\
pandas.DatetimeIndex.indexer_at_time\
pandas.DatetimeIndex.indexer_between_time\
pandas.DatetimeIndex.snap\
pandas.DatetimeIndex.std\
pandas.DatetimeIndex.to_period\
pandas.DatetimeIndex.to_pydatetime\
pandas.DatetimeIndex.tz_convert\
pandas.HDFStore.info\
pandas.Index.append\
pandas.Index.difference\
pandas.Index.drop_duplicates\
pandas.Index.droplevel\
pandas.Index.dropna\
pandas.Index.duplicated\
pandas.Index.fillna\
pandas.Index.get_loc\
pandas.Index.insert\
pandas.Index.intersection\
pandas.Index.join\
pandas.Index.memory_usage\
pandas.Index.nunique\
pandas.Index.putmask\
pandas.Index.ravel\
pandas.Index.slice_indexer\
pandas.Index.slice_locs\
pandas.Index.symmetric_difference\
pandas.Index.to_list\
pandas.Index.union\
pandas.Index.unique\
pandas.Index.value_counts\
pandas.IntervalIndex.contains\
pandas.IntervalIndex.get_loc\
pandas.IntervalIndex.set_closed\
pandas.IntervalIndex.to_tuples\
pandas.MultiIndex.copy\
pandas.MultiIndex.drop\
pandas.MultiIndex.droplevel\
pandas.MultiIndex.remove_unused_levels\
pandas.MultiIndex.reorder_levels\
pandas.MultiIndex.set_levels\
pandas.MultiIndex.to_frame\
pandas.PeriodIndex.to_timestamp\
pandas.Series.__iter__\
pandas.Series.astype\
pandas.Series.at_time\
pandas.Series.case_when\
pandas.Series.cat.set_categories\
pandas.Series.dt.to_period\
pandas.Series.dt.tz_convert\
pandas.Series.ewm\
pandas.Series.expanding\
pandas.Series.filter\
pandas.Series.first_valid_index\
pandas.Series.get\
pandas.Series.infer_objects\
pandas.Series.kurt\
pandas.Series.kurtosis\
pandas.Series.last_valid_index\
pandas.Series.mask\
pandas.Series.max\
pandas.Series.mean\
pandas.Series.median\
pandas.Series.min\
pandas.Series.nunique\
pandas.Series.pipe\
pandas.Series.plot.box\
pandas.Series.plot.density\
pandas.Series.plot.kde\
pandas.Series.pop\
pandas.Series.prod\
pandas.Series.product\
pandas.Series.reindex\
pandas.Series.reorder_levels\
pandas.Series.sem\
pandas.Series.skew\
pandas.Series.sparse.to_coo\
pandas.Series.std\
pandas.Series.str.capitalize\
pandas.Series.str.casefold\
pandas.Series.str.center\
pandas.Series.str.decode\
pandas.Series.str.encode\
pandas.Series.str.find\
pandas.Series.str.fullmatch\
pandas.Series.str.get\
pandas.Series.str.index\
pandas.Series.str.ljust\
pandas.Series.str.lower\
pandas.Series.str.lstrip\
pandas.Series.str.match\
pandas.Series.str.normalize\
pandas.Series.str.partition\
pandas.Series.str.rfind\
pandas.Series.str.rindex\
pandas.Series.str.rjust\
pandas.Series.str.rpartition\
pandas.Series.str.rstrip\
pandas.Series.str.strip\
pandas.Series.str.swapcase\
pandas.Series.str.title\
pandas.Series.str.translate\
pandas.Series.str.upper\
pandas.Series.str.wrap\
pandas.Series.str.zfill\
pandas.Series.sum\
pandas.Series.to_list\
pandas.Series.to_numpy\
pandas.Series.to_timestamp\
pandas.Series.value_counts\
pandas.Series.var\
pandas.Series.where\
pandas.TimedeltaIndex.as_unit\
pandas.TimedeltaIndex.to_pytimedelta\
pandas.api.extensions.ExtensionArray._accumulate\
pandas.api.extensions.ExtensionArray._hash_pandas_object\
pandas.api.extensions.ExtensionArray._pad_or_backfill\
pandas.api.extensions.ExtensionArray._reduce\
pandas.api.extensions.ExtensionArray.copy\
pandas.api.extensions.ExtensionArray.dropna\
pandas.api.extensions.ExtensionArray.duplicated\
pandas.api.extensions.ExtensionArray.insert\
pandas.api.extensions.ExtensionArray.isin\
pandas.api.extensions.ExtensionArray.ravel\
pandas.api.extensions.ExtensionArray.take\
pandas.api.extensions.ExtensionArray.tolist\
pandas.api.extensions.ExtensionArray.unique\
pandas.api.interchange.from_dataframe\
pandas.api.types.is_hashable\
pandas.api.types.pandas_dtype\
pandas.api.types.union_categoricals\
pandas.arrays.IntervalArray.contains\
pandas.arrays.IntervalArray.set_closed\
pandas.arrays.IntervalArray.to_tuples\
pandas.bdate_range\
pandas.core.groupby.DataFrameGroupBy.__iter__\
pandas.core.groupby.DataFrameGroupBy.agg\
pandas.core.groupby.DataFrameGroupBy.aggregate\
pandas.core.groupby.DataFrameGroupBy.apply\
pandas.core.groupby.DataFrameGroupBy.boxplot\
pandas.core.groupby.DataFrameGroupBy.cummax\
pandas.core.groupby.DataFrameGroupBy.cummin\
pandas.core.groupby.DataFrameGroupBy.cumprod\
pandas.core.groupby.DataFrameGroupBy.cumsum\
pandas.core.groupby.DataFrameGroupBy.filter\
pandas.core.groupby.DataFrameGroupBy.get_group\
pandas.core.groupby.DataFrameGroupBy.hist\
pandas.core.groupby.DataFrameGroupBy.mean\
pandas.core.groupby.DataFrameGroupBy.nunique\
pandas.core.groupby.DataFrameGroupBy.rank\
pandas.core.groupby.DataFrameGroupBy.resample\
pandas.core.groupby.DataFrameGroupBy.skew\
pandas.core.groupby.DataFrameGroupBy.transform\
pandas.core.groupby.SeriesGroupBy.__iter__\
pandas.core.groupby.SeriesGroupBy.agg\
pandas.core.groupby.SeriesGroupBy.aggregate\
pandas.core.groupby.SeriesGroupBy.apply\
pandas.core.groupby.SeriesGroupBy.cummax\
pandas.core.groupby.SeriesGroupBy.cummin\
pandas.core.groupby.SeriesGroupBy.cumprod\
pandas.core.groupby.SeriesGroupBy.cumsum\
pandas.core.groupby.SeriesGroupBy.filter\
pandas.core.groupby.SeriesGroupBy.get_group\
pandas.core.groupby.SeriesGroupBy.mean\
pandas.core.groupby.SeriesGroupBy.rank\
pandas.core.groupby.SeriesGroupBy.resample\
pandas.core.groupby.SeriesGroupBy.skew\
pandas.core.groupby.SeriesGroupBy.transform\
pandas.core.resample.Resampler.__iter__\
pandas.core.resample.Resampler.ffill\
pandas.core.resample.Resampler.get_group\
pandas.core.resample.Resampler.max\
pandas.core.resample.Resampler.min\
pandas.core.resample.Resampler.transform\
pandas.date_range\
pandas.interval_range\
pandas.io.formats.style.Styler.apply\
pandas.io.formats.style.Styler.apply_index\
pandas.io.formats.style.Styler.background_gradient\
pandas.io.formats.style.Styler.bar\
pandas.io.formats.style.Styler.concat\
pandas.io.formats.style.Styler.export\
pandas.io.formats.style.Styler.format\
pandas.io.formats.style.Styler.format_index\
pandas.io.formats.style.Styler.hide\
pandas.io.formats.style.Styler.highlight_between\
pandas.io.formats.style.Styler.highlight_max\
pandas.io.formats.style.Styler.highlight_min\
pandas.io.formats.style.Styler.highlight_null\
pandas.io.formats.style.Styler.highlight_quantile\
pandas.io.formats.style.Styler.map\
pandas.io.formats.style.Styler.map_index\
pandas.io.formats.style.Styler.relabel_index\
pandas.io.formats.style.Styler.set_caption\
pandas.io.formats.style.Styler.set_properties\
pandas.io.formats.style.Styler.set_sticky\
pandas.io.formats.style.Styler.set_table_attributes\
pandas.io.formats.style.Styler.set_table_styles\
pandas.io.formats.style.Styler.set_td_classes\
pandas.io.formats.style.Styler.set_tooltips\
pandas.io.formats.style.Styler.set_uuid\
pandas.io.formats.style.Styler.text_gradient\
pandas.io.formats.style.Styler.use\
pandas.io.json.build_table_schema\
pandas.io.stata.StataReader.value_labels\
pandas.io.stata.StataReader.variable_labels\
pandas.json_normalize\
pandas.merge_asof\
pandas.period_range\
pandas.plotting.andrews_curves\
pandas.plotting.autocorrelation_plot\
pandas.plotting.lag_plot\
pandas.plotting.parallel_coordinates\
pandas.plotting.radviz\
pandas.plotting.table\
pandas.read_feather\
pandas.read_orc\
pandas.read_sas\
pandas.read_spss\
pandas.read_sql\
pandas.read_sql_query\
pandas.read_stata\
pandas.set_eng_float_format\
pandas.timedelta_range\
pandas.util.hash_pandas_object # There should be no backslash in the final line, please keep this comment in the last ignored function
RET=$(($RET + $?)) ; echo $MSG "DONE"

Currently, some methods fail the RT03 check.

The task here is:

  1. take 2-4 methods
  2. run: scripts/validate_docstrings.py --format=actions --errors=RT03 method-name
  3. check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
  4. remove those methods from code_checks.sh
  5. commit, push, open pull request

Please don't comment take as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work.

If you're new contributor, please check the contributing guide
@jordan-d-murphy
Copy link
Contributor Author

I don't have permission to add them, but this could probably use some labels:

  • CI
  • Docs
  • good first issue

@jordan-d-murphy
Copy link
Contributor Author

Addresses #57356

@lithomas1 lithomas1 added the Docs label Feb 16, 2024
This was referenced Feb 19, 2024
Closed
Closed
@bergnerjonas
Copy link
Contributor

Will work on

  • pandas.Index.to_numpy
  • pandas.Categorical.set_categories

@bergnerjonas bergnerjonas mentioned this issue Feb 24, 2024
Merged
5 tasks
@bergnerjonas
Copy link
Contributor

bergnerjonas commented Feb 24, 2024 •
edited
Loading

Continue with:

  • pandas.CategoricalIndex.set_categories (already valid)
  • pandas.DataFrame.astype
  • pandas.DataFrame.at_time
  • pandas.DataFrame.ewm

@bergnerjonas bergnerjonas mentioned this issue Feb 24, 2024
Merged
5 tasks
@jordan-d-murphy jordan-d-murphy mentioned this issue Feb 25, 2024
Merged
5 tasks
@jordan-d-murphy
Copy link
Contributor Author

opened a fix for pandas.DataFrame.expanding

@jordan-d-murphy jordan-d-murphy mentioned this issue Feb 26, 2024
Closed
@YashpalAhlawat YashpalAhlawat mentioned this issue Feb 27, 2024
Merged
5 tasks
@YashpalAhlawat
Copy link
Contributor

opened a fix for pandas.read_sql

@YashpalAhlawat YashpalAhlawat mentioned this issue Feb 27, 2024
Merged
5 tasks
@YashpalAhlawat
Copy link
Contributor

Opened a fix for pandas.read_sql_query, pandas.read_feather

@YashpalAhlawat YashpalAhlawat mentioned this issue Feb 29, 2024
Closed
5 tasks
@YashpalAhlawat
Copy link
Contributor

Opened a fix for below methods:
pandas.DataFrame.min
pandas.DataFrame.max
pandas.DataFrame.mean
pandas.DataFrame.median
pandas.DataFrame.skew
pandas.DataFrame.kurt

@bergnerjonas
Copy link
Contributor

bergnerjonas commented Mar 3, 2024 •
edited
Loading

Will work on:
pandas.DataFrame.expanding - works already
pandas.DataFrame.filter
pandas.DataFrame.first_valid_index
pandas.DataFrame.last_valid_index
pandas.DataFrame.get

@bergnerjonas bergnerjonas mentioned this issue Mar 8, 2024
Merged
4 tasks
@bergnerjonas
Copy link
Contributor

Continue with:
pandas.DataFrame.nsmallest
pandas.DataFrame.nunique
pandas.DataFrame.pipe
pandas.DataFrame.plot.box
pandas.DataFrame.plot.density
pandas.DataFrame.plot.kde
pandas.DataFrame.plot.scatter

@bergnerjonas bergnerjonas mentioned this issue Mar 8, 2024
Merged
4 tasks
@bergnerjonas
Copy link
Contributor

bergnerjonas commented Mar 10, 2024 •
edited
Loading

Will work on:

  • pandas.DataFrame.pop
  • pandas.DataFrame.reindex
  • pandas.DataFrame.reorder_levels
  • pandas.DataFrame.swapaxes - deprecated in favor of .transpose, which already has valid docstring
  • pandas.DataFrame.to_numpy
  • pandas.DataFrame.to_orc

@bergnerjonas
Copy link
Contributor

bergnerjonas commented Mar 10, 2024 •
edited
Loading

pandas/ci/code_checks.sh

Lines 615 to 864 in dc19148

MSG='Partially validate docstrings (RT03)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=RT03 --ignore_functions \
pandas.DataFrame.hist\
pandas.DataFrame.infer_objects\
pandas.DataFrame.kurt\
pandas.DataFrame.kurtosis\
pandas.DataFrame.mask\
pandas.DataFrame.max\
pandas.DataFrame.mean\
pandas.DataFrame.median\
pandas.DataFrame.min\
pandas.DataFrame.pop\
pandas.DataFrame.prod\
pandas.DataFrame.product\
pandas.DataFrame.reindex\
pandas.DataFrame.reorder_levels\
pandas.DataFrame.sem\
pandas.DataFrame.skew\
pandas.DataFrame.std\
pandas.DataFrame.sum\
pandas.DataFrame.swapaxes\
pandas.DataFrame.to_numpy\
pandas.DataFrame.to_orc\
pandas.DataFrame.to_parquet\
pandas.DataFrame.unstack\
pandas.DataFrame.value_counts\
pandas.DataFrame.var\
pandas.DataFrame.where\
pandas.DatetimeIndex.indexer_at_time\
pandas.DatetimeIndex.indexer_between_time\
pandas.DatetimeIndex.snap\
pandas.DatetimeIndex.std\
pandas.DatetimeIndex.to_period\
pandas.DatetimeIndex.to_pydatetime\
pandas.DatetimeIndex.tz_convert\
pandas.HDFStore.info\
pandas.Index.append\
pandas.Index.difference\
pandas.Index.drop_duplicates\
pandas.Index.droplevel\
pandas.Index.dropna\
pandas.Index.duplicated\
pandas.Index.fillna\
pandas.Index.get_loc\
pandas.Index.insert\
pandas.Index.intersection\
pandas.Index.join\
pandas.Index.memory_usage\
pandas.Index.nunique\
pandas.Index.putmask\
pandas.Index.ravel\
pandas.Index.slice_indexer\
pandas.Index.slice_locs\
pandas.Index.symmetric_difference\
pandas.Index.to_list\
pandas.Index.union\
pandas.Index.unique\
pandas.Index.value_counts\
pandas.IntervalIndex.contains\
pandas.IntervalIndex.get_loc\
pandas.IntervalIndex.set_closed\
pandas.IntervalIndex.to_tuples\
pandas.MultiIndex.copy\
pandas.MultiIndex.drop\
pandas.MultiIndex.droplevel\
pandas.MultiIndex.remove_unused_levels\
pandas.MultiIndex.reorder_levels\
pandas.MultiIndex.set_levels\
pandas.MultiIndex.to_frame\
pandas.PeriodIndex.to_timestamp\
pandas.Series.__iter__\
pandas.Series.astype\
pandas.Series.at_time\
pandas.Series.case_when\
pandas.Series.cat.set_categories\
pandas.Series.dt.to_period\
pandas.Series.dt.tz_convert\
pandas.Series.ewm\
pandas.Series.expanding\
pandas.Series.filter\
pandas.Series.first_valid_index\
pandas.Series.get\
pandas.Series.infer_objects\
pandas.Series.kurt\
pandas.Series.kurtosis\
pandas.Series.last_valid_index\
pandas.Series.mask\
pandas.Series.max\
pandas.Series.mean\
pandas.Series.median\
pandas.Series.min\
pandas.Series.nunique\
pandas.Series.pipe\
pandas.Series.plot.box\
pandas.Series.plot.density\
pandas.Series.plot.kde\
pandas.Series.pop\
pandas.Series.prod\
pandas.Series.product\
pandas.Series.reindex\
pandas.Series.reorder_levels\
pandas.Series.sem\
pandas.Series.skew\
pandas.Series.sparse.to_coo\
pandas.Series.std\
pandas.Series.str.capitalize\
pandas.Series.str.casefold\
pandas.Series.str.center\
pandas.Series.str.decode\
pandas.Series.str.encode\
pandas.Series.str.find\
pandas.Series.str.fullmatch\
pandas.Series.str.get\
pandas.Series.str.index\
pandas.Series.str.ljust\
pandas.Series.str.lower\
pandas.Series.str.lstrip\
pandas.Series.str.match\
pandas.Series.str.normalize\
pandas.Series.str.partition\
pandas.Series.str.rfind\
pandas.Series.str.rindex\
pandas.Series.str.rjust\
pandas.Series.str.rpartition\
pandas.Series.str.rstrip\
pandas.Series.str.strip\
pandas.Series.str.swapcase\
pandas.Series.str.title\
pandas.Series.str.translate\
pandas.Series.str.upper\
pandas.Series.str.wrap\
pandas.Series.str.zfill\
pandas.Series.sum\
pandas.Series.to_list\
pandas.Series.to_numpy\
pandas.Series.to_timestamp\
pandas.Series.value_counts\
pandas.Series.var\
pandas.Series.where\
pandas.TimedeltaIndex.as_unit\
pandas.TimedeltaIndex.to_pytimedelta\
pandas.api.extensions.ExtensionArray._accumulate\
pandas.api.extensions.ExtensionArray._hash_pandas_object\
pandas.api.extensions.ExtensionArray._pad_or_backfill\
pandas.api.extensions.ExtensionArray._reduce\
pandas.api.extensions.ExtensionArray.copy\
pandas.api.extensions.ExtensionArray.dropna\
pandas.api.extensions.ExtensionArray.duplicated\
pandas.api.extensions.ExtensionArray.insert\
pandas.api.extensions.ExtensionArray.isin\
pandas.api.extensions.ExtensionArray.ravel\
pandas.api.extensions.ExtensionArray.take\
pandas.api.extensions.ExtensionArray.tolist\
pandas.api.extensions.ExtensionArray.unique\
pandas.api.interchange.from_dataframe\
pandas.api.types.is_hashable\
pandas.api.types.pandas_dtype\
pandas.api.types.union_categoricals\
pandas.arrays.IntervalArray.contains\
pandas.arrays.IntervalArray.set_closed\
pandas.arrays.IntervalArray.to_tuples\
pandas.bdate_range\
pandas.core.groupby.DataFrameGroupBy.__iter__\
pandas.core.groupby.DataFrameGroupBy.agg\
pandas.core.groupby.DataFrameGroupBy.aggregate\
pandas.core.groupby.DataFrameGroupBy.apply\
pandas.core.groupby.DataFrameGroupBy.boxplot\
pandas.core.groupby.DataFrameGroupBy.cummax\
pandas.core.groupby.DataFrameGroupBy.cummin\
pandas.core.groupby.DataFrameGroupBy.cumprod\
pandas.core.groupby.DataFrameGroupBy.cumsum\
pandas.core.groupby.DataFrameGroupBy.filter\
pandas.core.groupby.DataFrameGroupBy.get_group\
pandas.core.groupby.DataFrameGroupBy.hist\
pandas.core.groupby.DataFrameGroupBy.mean\
pandas.core.groupby.DataFrameGroupBy.nunique\
pandas.core.groupby.DataFrameGroupBy.rank\
pandas.core.groupby.DataFrameGroupBy.resample\
pandas.core.groupby.DataFrameGroupBy.skew\
pandas.core.groupby.DataFrameGroupBy.transform\
pandas.core.groupby.SeriesGroupBy.__iter__\
pandas.core.groupby.SeriesGroupBy.agg\
pandas.core.groupby.SeriesGroupBy.aggregate\
pandas.core.groupby.SeriesGroupBy.apply\
pandas.core.groupby.SeriesGroupBy.cummax\
pandas.core.groupby.SeriesGroupBy.cummin\
pandas.core.groupby.SeriesGroupBy.cumprod\
pandas.core.groupby.SeriesGroupBy.cumsum\
pandas.core.groupby.SeriesGroupBy.filter\
pandas.core.groupby.SeriesGroupBy.get_group\
pandas.core.groupby.SeriesGroupBy.mean\
pandas.core.groupby.SeriesGroupBy.rank\
pandas.core.groupby.SeriesGroupBy.resample\
pandas.core.groupby.SeriesGroupBy.skew\
pandas.core.groupby.SeriesGroupBy.transform\
pandas.core.resample.Resampler.__iter__\
pandas.core.resample.Resampler.ffill\
pandas.core.resample.Resampler.get_group\
pandas.core.resample.Resampler.max\
pandas.core.resample.Resampler.min\
pandas.core.resample.Resampler.transform\
pandas.date_range\
pandas.interval_range\
pandas.io.formats.style.Styler.apply\
pandas.io.formats.style.Styler.apply_index\
pandas.io.formats.style.Styler.background_gradient\
pandas.io.formats.style.Styler.bar\
pandas.io.formats.style.Styler.concat\
pandas.io.formats.style.Styler.export\
pandas.io.formats.style.Styler.format\
pandas.io.formats.style.Styler.format_index\
pandas.io.formats.style.Styler.hide\
pandas.io.formats.style.Styler.highlight_between\
pandas.io.formats.style.Styler.highlight_max\
pandas.io.formats.style.Styler.highlight_min\
pandas.io.formats.style.Styler.highlight_null\
pandas.io.formats.style.Styler.highlight_quantile\
pandas.io.formats.style.Styler.map\
pandas.io.formats.style.Styler.map_index\
pandas.io.formats.style.Styler.relabel_index\
pandas.io.formats.style.Styler.set_caption\
pandas.io.formats.style.Styler.set_properties\
pandas.io.formats.style.Styler.set_sticky\
pandas.io.formats.style.Styler.set_table_attributes\
pandas.io.formats.style.Styler.set_table_styles\
pandas.io.formats.style.Styler.set_td_classes\
pandas.io.formats.style.Styler.set_tooltips\
pandas.io.formats.style.Styler.set_uuid\
pandas.io.formats.style.Styler.text_gradient\
pandas.io.formats.style.Styler.use\
pandas.io.json.build_table_schema\
pandas.io.stata.StataReader.value_labels\
pandas.io.stata.StataReader.variable_labels\
pandas.json_normalize\
pandas.merge_asof\
pandas.period_range\
pandas.plotting.andrews_curves\
pandas.plotting.autocorrelation_plot\
pandas.plotting.lag_plot\
pandas.plotting.parallel_coordinates\
pandas.plotting.radviz\
pandas.plotting.table\
pandas.read_orc\
pandas.read_sas\
pandas.read_spss\
pandas.read_stata\
pandas.set_eng_float_format\
pandas.timedelta_range\
pandas.util.hash_pandas_object # There should be no backslash in the final line, please keep this comment in the last ignored function
RET=$(($RET + $?)) ; echo $MSG "DONE"

Current status: still 200+ method docstrings need to be fixed, maybe add the "good first issue" tag to get more people involved ;)

@bergnerjonas bergnerjonas mentioned this issue Mar 10, 2024
Merged
4 tasks
@jordan-d-murphy
Copy link
Contributor Author

agreed! I don't have permissions to add labels, otherwise I would. hopefully a core team member can add that label for us.

thanks for all your work on these!

@jordan-d-murphy jordan-d-murphy mentioned this issue Mar 10, 2024
Merged
5 tasks
@jordan-d-murphy
Copy link
Contributor Author

opened a fix for

pandas.timedelta_range 
pandas.util.hash_pandas_object

@jordan-d-murphy jordan-d-murphy mentioned this issue Mar 10, 2024
Merged
5 tasks
@jordan-d-murphy
Copy link
Contributor Author

jordan-d-murphy commented Mar 10, 2024 •
edited
Loading

opened a fix for

pandas.read_orc
pandas.read_sas
pandas.read_spss
pandas.read_stata

@quangngd quangngd mentioned this issue Mar 16, 2024
Merged
5 tasks
@jordan-d-murphy jordan-d-murphy mentioned this issue Mar 17, 2024
Merged
2 tasks
@jordan-d-murphy
Copy link
Contributor Author

jordan-d-murphy commented Mar 17, 2024 •
edited
Loading

Hi all, if CI: speedup docstring check consecutive runs #57826 gets merged in, I might be reworking our approach here; this would look like closing the following issues:

DOC: fix GL08 errors in docstrings
DOC: fix PR01 errors in docstrings
DOC: fix PR07 errors in docstrings
DOC: fix SA01 errors in docstrings
DOC: fix RT03 errors in docstrings
DOC: fix PR02 errors in docstrings

And opening a new issue to address these based on the new approach.

tl;dr

the work can still be done, but probably under a new ticket once #57826 is merged in

This was referenced Mar 17, 2024
Closed
Closed
Closed
Closed
Merged
@jordan-d-murphy
Copy link
Contributor Author

Closed by:
CI: speedup docstring check consecutive runs #57826
CI: Better error control in the validation of docstrings #57879

Opening a new issue to fix docstring errors.

@jordan-d-murphy
Copy link
Contributor Author

Opened DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063 as a parent issue for fixing docstrings based on the refactoring in code_checks.sh

Feel free to swing by and help out! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@YashpalAhlawat @jordan-d-murphy @bergnerjonas @rhshadrach @lithomas1