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 SA01 errors in docstrings #57417

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

DOC: fix SA01 errors in docstrings #57417

jordan-d-murphy opened this issue Feb 14, 2024 · 8 comments
Labels

Comments

@jordan-d-murphy
Copy link
Contributor

Pandas has a script for validating docstrings:

pandas/ci/code_checks.sh

Lines 416 to 1426 in 44c50b2

MSG='Partially validate docstrings (SA01)' ; echo $MSG
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA01 --ignore_functions \
pandas.ArrowDtype\
pandas.BooleanDtype\
pandas.Categorical.__array__\
pandas.Categorical.as_ordered\
pandas.Categorical.as_unordered\
pandas.Categorical.codes\
pandas.Categorical.dtype\
pandas.Categorical.from_codes\
pandas.Categorical.ordered\
pandas.CategoricalDtype.categories\
pandas.CategoricalDtype.ordered\
pandas.CategoricalIndex.as_ordered\
pandas.CategoricalIndex.as_unordered\
pandas.CategoricalIndex.codes\
pandas.CategoricalIndex.equals\
pandas.CategoricalIndex.ordered\
pandas.DataFrame.__dataframe__\
pandas.DataFrame.__iter__\
pandas.DataFrame.align\
pandas.DataFrame.assign\
pandas.DataFrame.axes\
pandas.DataFrame.backfill\
pandas.DataFrame.bfill\
pandas.DataFrame.columns\
pandas.DataFrame.copy\
pandas.DataFrame.droplevel\
pandas.DataFrame.dtypes\
pandas.DataFrame.ffill\
pandas.DataFrame.first_valid_index\
pandas.DataFrame.get\
pandas.DataFrame.keys\
pandas.DataFrame.kurt\
pandas.DataFrame.kurtosis\
pandas.DataFrame.last_valid_index\
pandas.DataFrame.mean\
pandas.DataFrame.median\
pandas.DataFrame.pad\
pandas.DataFrame.plot\
pandas.DataFrame.pop\
pandas.DataFrame.reorder_levels\
pandas.DataFrame.sem\
pandas.DataFrame.skew\
pandas.DataFrame.sparse\
pandas.DataFrame.sparse.density\
pandas.DataFrame.sparse.from_spmatrix\
pandas.DataFrame.sparse.to_coo\
pandas.DataFrame.sparse.to_dense\
pandas.DataFrame.std\
pandas.DataFrame.swapaxes\
pandas.DataFrame.swaplevel\
pandas.DataFrame.to_feather\
pandas.DataFrame.to_markdown\
pandas.DataFrame.to_period\
pandas.DataFrame.to_timestamp\
pandas.DataFrame.tz_convert\
pandas.DataFrame.tz_localize\
pandas.DataFrame.var\
pandas.DatetimeIndex.ceil\
pandas.DatetimeIndex.date\
pandas.DatetimeIndex.day\
pandas.DatetimeIndex.day_name\
pandas.DatetimeIndex.day_of_year\
pandas.DatetimeIndex.dayofyear\
pandas.DatetimeIndex.floor\
pandas.DatetimeIndex.freqstr\
pandas.DatetimeIndex.hour\
pandas.DatetimeIndex.inferred_freq\
pandas.DatetimeIndex.is_leap_year\
pandas.DatetimeIndex.microsecond\
pandas.DatetimeIndex.minute\
pandas.DatetimeIndex.month\
pandas.DatetimeIndex.month_name\
pandas.DatetimeIndex.nanosecond\
pandas.DatetimeIndex.quarter\
pandas.DatetimeIndex.round\
pandas.DatetimeIndex.second\
pandas.DatetimeIndex.snap\
pandas.DatetimeIndex.time\
pandas.DatetimeIndex.timetz\
pandas.DatetimeIndex.to_pydatetime\
pandas.DatetimeIndex.tz\
pandas.DatetimeIndex.year\
pandas.DatetimeTZDtype\
pandas.DatetimeTZDtype.tz\
pandas.DatetimeTZDtype.unit\
pandas.ExcelFile\
pandas.ExcelFile.parse\
pandas.ExcelWriter\
pandas.Flags\
pandas.Float32Dtype\
pandas.Float64Dtype\
pandas.Grouper\
pandas.HDFStore.append\
pandas.HDFStore.get\
pandas.HDFStore.groups\
pandas.HDFStore.info\
pandas.HDFStore.keys\
pandas.HDFStore.put\
pandas.HDFStore.select\
pandas.HDFStore.walk\
pandas.Index.T\
pandas.Index.append\
pandas.Index.astype\
pandas.Index.copy\
pandas.Index.difference\
pandas.Index.drop\
pandas.Index.droplevel\
pandas.Index.dropna\
pandas.Index.dtype\
pandas.Index.equals\
pandas.Index.get_indexer\
pandas.Index.get_indexer_for\
pandas.Index.get_indexer_non_unique\
pandas.Index.get_loc\
pandas.Index.hasnans\
pandas.Index.identical\
pandas.Index.inferred_type\
pandas.Index.insert\
pandas.Index.intersection\
pandas.Index.item\
pandas.Index.join\
pandas.Index.map\
pandas.Index.name\
pandas.Index.nbytes\
pandas.Index.ndim\
pandas.Index.shape\
pandas.Index.size\
pandas.Index.slice_indexer\
pandas.Index.str\
pandas.Index.symmetric_difference\
pandas.Index.union\
pandas.Int16Dtype\
pandas.Int32Dtype\
pandas.Int64Dtype\
pandas.Int8Dtype\
pandas.Interval.closed\
pandas.Interval.left\
pandas.Interval.mid\
pandas.Interval.right\
pandas.IntervalDtype\
pandas.IntervalDtype.subtype\
pandas.IntervalIndex.closed\
pandas.IntervalIndex.get_indexer\
pandas.IntervalIndex.get_loc\
pandas.IntervalIndex.is_non_overlapping_monotonic\
pandas.IntervalIndex.set_closed\
pandas.IntervalIndex.to_tuples\
pandas.MultiIndex.append\
pandas.MultiIndex.copy\
pandas.MultiIndex.drop\
pandas.MultiIndex.droplevel\
pandas.MultiIndex.dtypes\
pandas.MultiIndex.get_indexer\
pandas.MultiIndex.get_level_values\
pandas.MultiIndex.levels\
pandas.MultiIndex.levshape\
pandas.MultiIndex.names\
pandas.MultiIndex.nlevels\
pandas.MultiIndex.remove_unused_levels\
pandas.MultiIndex.reorder_levels\
pandas.MultiIndex.set_codes\
pandas.MultiIndex.set_levels\
pandas.MultiIndex.sortlevel\
pandas.MultiIndex.truncate\
pandas.NA\
pandas.NaT\
pandas.NamedAgg\
pandas.Period\
pandas.Period.asfreq\
pandas.Period.freqstr\
pandas.Period.is_leap_year\
pandas.Period.month\
pandas.Period.now\
pandas.Period.quarter\
pandas.Period.strftime\
pandas.Period.to_timestamp\
pandas.Period.year\
pandas.PeriodDtype\
pandas.PeriodDtype.freq\
pandas.PeriodIndex.day\
pandas.PeriodIndex.day_of_week\
pandas.PeriodIndex.day_of_year\
pandas.PeriodIndex.dayofweek\
pandas.PeriodIndex.dayofyear\
pandas.PeriodIndex.days_in_month\
pandas.PeriodIndex.daysinmonth\
pandas.PeriodIndex.freqstr\
pandas.PeriodIndex.from_fields\
pandas.PeriodIndex.from_ordinals\
pandas.PeriodIndex.hour\
pandas.PeriodIndex.is_leap_year\
pandas.PeriodIndex.minute\
pandas.PeriodIndex.month\
pandas.PeriodIndex.quarter\
pandas.PeriodIndex.second\
pandas.PeriodIndex.to_timestamp\
pandas.PeriodIndex.week\
pandas.PeriodIndex.weekday\
pandas.PeriodIndex.weekofyear\
pandas.PeriodIndex.year\
pandas.RangeIndex.from_range\
pandas.RangeIndex.start\
pandas.RangeIndex.step\
pandas.RangeIndex.stop\
pandas.Series\
pandas.Series.T\
pandas.Series.__iter__\
pandas.Series.align\
pandas.Series.backfill\
pandas.Series.bfill\
pandas.Series.cat\
pandas.Series.cat.as_ordered\
pandas.Series.cat.as_unordered\
pandas.Series.cat.codes\
pandas.Series.cat.ordered\
pandas.Series.copy\
pandas.Series.droplevel\
pandas.Series.dt.ceil\
pandas.Series.dt.components\
pandas.Series.dt.date\
pandas.Series.dt.day\
pandas.Series.dt.day_name\
pandas.Series.dt.day_of_year\
pandas.Series.dt.dayofyear\
pandas.Series.dt.days\
pandas.Series.dt.days_in_month\
pandas.Series.dt.daysinmonth\
pandas.Series.dt.floor\
pandas.Series.dt.hour\
pandas.Series.dt.is_leap_year\
pandas.Series.dt.microsecond\
pandas.Series.dt.microseconds\
pandas.Series.dt.minute\
pandas.Series.dt.month\
pandas.Series.dt.month_name\
pandas.Series.dt.nanosecond\
pandas.Series.dt.nanoseconds\
pandas.Series.dt.quarter\
pandas.Series.dt.round\
pandas.Series.dt.second\
pandas.Series.dt.seconds\
pandas.Series.dt.time\
pandas.Series.dt.timetz\
pandas.Series.dt.tz\
pandas.Series.dt.year\
pandas.Series.dtype\
pandas.Series.dtypes\
pandas.Series.eq\
pandas.Series.ffill\
pandas.Series.first_valid_index\
pandas.Series.ge\
pandas.Series.get\
pandas.Series.gt\
pandas.Series.hasnans\
pandas.Series.is_monotonic_decreasing\
pandas.Series.is_monotonic_increasing\
pandas.Series.is_unique\
pandas.Series.item\
pandas.Series.keys\
pandas.Series.kurt\
pandas.Series.kurtosis\
pandas.Series.last_valid_index\
pandas.Series.le\
pandas.Series.list.__getitem__\
pandas.Series.list.flatten\
pandas.Series.list.len\
pandas.Series.lt\
pandas.Series.mean\
pandas.Series.median\
pandas.Series.mode\
pandas.Series.nbytes\
pandas.Series.ndim\
pandas.Series.ne\
pandas.Series.pad\
pandas.Series.plot\
pandas.Series.pop\
pandas.Series.reorder_levels\
pandas.Series.sem\
pandas.Series.shape\
pandas.Series.size\
pandas.Series.skew\
pandas.Series.sparse\
pandas.Series.sparse.density\
pandas.Series.sparse.fill_value\
pandas.Series.sparse.from_coo\
pandas.Series.sparse.npoints\
pandas.Series.sparse.sp_values\
pandas.Series.sparse.to_coo\
pandas.Series.std\
pandas.Series.str\
pandas.Series.str.center\
pandas.Series.str.decode\
pandas.Series.str.encode\
pandas.Series.str.get\
pandas.Series.str.ljust\
pandas.Series.str.normalize\
pandas.Series.str.repeat\
pandas.Series.str.replace\
pandas.Series.str.rjust\
pandas.Series.str.translate\
pandas.Series.str.wrap\
pandas.Series.struct.dtypes\
pandas.Series.swaplevel\
pandas.Series.to_dict\
pandas.Series.to_frame\
pandas.Series.to_markdown\
pandas.Series.to_period\
pandas.Series.to_string\
pandas.Series.to_timestamp\
pandas.Series.tz_convert\
pandas.Series.tz_localize\
pandas.Series.unstack\
pandas.Series.update\
pandas.Series.var\
pandas.SparseDtype\
pandas.StringDtype\
pandas.Timedelta\
pandas.Timedelta.as_unit\
pandas.Timedelta.asm8\
pandas.Timedelta.ceil\
pandas.Timedelta.components\
pandas.Timedelta.days\
pandas.Timedelta.floor\
pandas.Timedelta.max\
pandas.Timedelta.min\
pandas.Timedelta.resolution\
pandas.Timedelta.round\
pandas.Timedelta.to_timedelta64\
pandas.Timedelta.total_seconds\
pandas.Timedelta.view\
pandas.TimedeltaIndex.as_unit\
pandas.TimedeltaIndex.ceil\
pandas.TimedeltaIndex.components\
pandas.TimedeltaIndex.days\
pandas.TimedeltaIndex.floor\
pandas.TimedeltaIndex.inferred_freq\
pandas.TimedeltaIndex.microseconds\
pandas.TimedeltaIndex.nanoseconds\
pandas.TimedeltaIndex.round\
pandas.TimedeltaIndex.seconds\
pandas.TimedeltaIndex.to_pytimedelta\
pandas.Timestamp\
pandas.Timestamp.as_unit\
pandas.Timestamp.asm8\
pandas.Timestamp.astimezone\
pandas.Timestamp.ceil\
pandas.Timestamp.combine\
pandas.Timestamp.ctime\
pandas.Timestamp.date\
pandas.Timestamp.day_name\
pandas.Timestamp.day_of_week\
pandas.Timestamp.day_of_year\
pandas.Timestamp.dayofweek\
pandas.Timestamp.dayofyear\
pandas.Timestamp.days_in_month\
pandas.Timestamp.daysinmonth\
pandas.Timestamp.dst\
pandas.Timestamp.floor\
pandas.Timestamp.fromordinal\
pandas.Timestamp.fromtimestamp\
pandas.Timestamp.is_leap_year\
pandas.Timestamp.isocalendar\
pandas.Timestamp.isoformat\
pandas.Timestamp.isoweekday\
pandas.Timestamp.max\
pandas.Timestamp.min\
pandas.Timestamp.month_name\
pandas.Timestamp.normalize\
pandas.Timestamp.now\
pandas.Timestamp.quarter\
pandas.Timestamp.replace\
pandas.Timestamp.resolution\
pandas.Timestamp.round\
pandas.Timestamp.strftime\
pandas.Timestamp.strptime\
pandas.Timestamp.time\
pandas.Timestamp.timestamp\
pandas.Timestamp.timetuple\
pandas.Timestamp.timetz\
pandas.Timestamp.to_datetime64\
pandas.Timestamp.to_julian_date\
pandas.Timestamp.to_period\
pandas.Timestamp.to_pydatetime\
pandas.Timestamp.today\
pandas.Timestamp.toordinal\
pandas.Timestamp.tz\
pandas.Timestamp.tz_convert\
pandas.Timestamp.tz_localize\
pandas.Timestamp.tzname\
pandas.Timestamp.unit\
pandas.Timestamp.utcfromtimestamp\
pandas.Timestamp.utcnow\
pandas.Timestamp.utcoffset\
pandas.Timestamp.utctimetuple\
pandas.Timestamp.week\
pandas.Timestamp.weekday\
pandas.Timestamp.weekofyear\
pandas.UInt16Dtype\
pandas.UInt32Dtype\
pandas.UInt64Dtype\
pandas.UInt8Dtype\
pandas.api.extensions.ExtensionArray\
pandas.api.extensions.ExtensionArray._accumulate\
pandas.api.extensions.ExtensionArray._concat_same_type\
pandas.api.extensions.ExtensionArray._formatter\
pandas.api.extensions.ExtensionArray._from_sequence\
pandas.api.extensions.ExtensionArray._from_sequence_of_strings\
pandas.api.extensions.ExtensionArray._hash_pandas_object\
pandas.api.extensions.ExtensionArray._pad_or_backfill\
pandas.api.extensions.ExtensionArray._reduce\
pandas.api.extensions.ExtensionArray._values_for_factorize\
pandas.api.extensions.ExtensionArray.astype\
pandas.api.extensions.ExtensionArray.copy\
pandas.api.extensions.ExtensionArray.dropna\
pandas.api.extensions.ExtensionArray.dtype\
pandas.api.extensions.ExtensionArray.duplicated\
pandas.api.extensions.ExtensionArray.equals\
pandas.api.extensions.ExtensionArray.fillna\
pandas.api.extensions.ExtensionArray.insert\
pandas.api.extensions.ExtensionArray.interpolate\
pandas.api.extensions.ExtensionArray.isin\
pandas.api.extensions.ExtensionArray.isna\
pandas.api.extensions.ExtensionArray.nbytes\
pandas.api.extensions.ExtensionArray.ndim\
pandas.api.extensions.ExtensionArray.ravel\
pandas.api.extensions.ExtensionArray.shape\
pandas.api.extensions.ExtensionArray.shift\
pandas.api.extensions.ExtensionArray.tolist\
pandas.api.extensions.ExtensionArray.unique\
pandas.api.extensions.ExtensionArray.view\
pandas.api.extensions.register_extension_dtype\
pandas.api.indexers.BaseIndexer\
pandas.api.indexers.FixedForwardWindowIndexer\
pandas.api.indexers.VariableOffsetWindowIndexer\
pandas.api.interchange.from_dataframe\
pandas.api.types.infer_dtype\
pandas.api.types.is_any_real_numeric_dtype\
pandas.api.types.is_bool\
pandas.api.types.is_bool_dtype\
pandas.api.types.is_categorical_dtype\
pandas.api.types.is_complex\
pandas.api.types.is_complex_dtype\
pandas.api.types.is_datetime64_any_dtype\
pandas.api.types.is_datetime64_dtype\
pandas.api.types.is_datetime64_ns_dtype\
pandas.api.types.is_datetime64tz_dtype\
pandas.api.types.is_dict_like\
pandas.api.types.is_extension_array_dtype\
pandas.api.types.is_file_like\
pandas.api.types.is_float\
pandas.api.types.is_float_dtype\
pandas.api.types.is_hashable\
pandas.api.types.is_int64_dtype\
pandas.api.types.is_integer\
pandas.api.types.is_integer_dtype\
pandas.api.types.is_interval_dtype\
pandas.api.types.is_iterator\
pandas.api.types.is_list_like\
pandas.api.types.is_named_tuple\
pandas.api.types.is_numeric_dtype\
pandas.api.types.is_object_dtype\
pandas.api.types.is_period_dtype\
pandas.api.types.is_re\
pandas.api.types.is_re_compilable\
pandas.api.types.is_scalar\
pandas.api.types.is_signed_integer_dtype\
pandas.api.types.is_sparse\
pandas.api.types.is_string_dtype\
pandas.api.types.is_timedelta64_dtype\
pandas.api.types.is_timedelta64_ns_dtype\
pandas.api.types.is_unsigned_integer_dtype\
pandas.api.types.pandas_dtype\
pandas.api.types.union_categoricals\
pandas.arrays.ArrowExtensionArray\
pandas.arrays.BooleanArray\
pandas.arrays.DatetimeArray\
pandas.arrays.FloatingArray\
pandas.arrays.IntegerArray\
pandas.arrays.IntervalArray.closed\
pandas.arrays.IntervalArray.is_non_overlapping_monotonic\
pandas.arrays.IntervalArray.left\
pandas.arrays.IntervalArray.length\
pandas.arrays.IntervalArray.mid\
pandas.arrays.IntervalArray.right\
pandas.arrays.IntervalArray.set_closed\
pandas.arrays.IntervalArray.to_tuples\
pandas.arrays.NumpyExtensionArray\
pandas.arrays.SparseArray\
pandas.arrays.TimedeltaArray\
pandas.bdate_range\
pandas.core.groupby.DataFrameGroupBy.__iter__\
pandas.core.groupby.DataFrameGroupBy.boxplot\
pandas.core.groupby.DataFrameGroupBy.filter\
pandas.core.groupby.DataFrameGroupBy.get_group\
pandas.core.groupby.DataFrameGroupBy.groups\
pandas.core.groupby.DataFrameGroupBy.indices\
pandas.core.groupby.DataFrameGroupBy.max\
pandas.core.groupby.DataFrameGroupBy.median\
pandas.core.groupby.DataFrameGroupBy.min\
pandas.core.groupby.DataFrameGroupBy.nunique\
pandas.core.groupby.DataFrameGroupBy.ohlc\
pandas.core.groupby.DataFrameGroupBy.plot\
pandas.core.groupby.DataFrameGroupBy.prod\
pandas.core.groupby.DataFrameGroupBy.sem\
pandas.core.groupby.DataFrameGroupBy.sum\
pandas.core.groupby.SeriesGroupBy.__iter__\
pandas.core.groupby.SeriesGroupBy.filter\
pandas.core.groupby.SeriesGroupBy.get_group\
pandas.core.groupby.SeriesGroupBy.groups\
pandas.core.groupby.SeriesGroupBy.indices\
pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing\
pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing\
pandas.core.groupby.SeriesGroupBy.max\
pandas.core.groupby.SeriesGroupBy.median\
pandas.core.groupby.SeriesGroupBy.min\
pandas.core.groupby.SeriesGroupBy.nunique\
pandas.core.groupby.SeriesGroupBy.ohlc\
pandas.core.groupby.SeriesGroupBy.plot\
pandas.core.groupby.SeriesGroupBy.prod\
pandas.core.groupby.SeriesGroupBy.sem\
pandas.core.groupby.SeriesGroupBy.sum\
pandas.core.resample.Resampler.__iter__\
pandas.core.resample.Resampler.get_group\
pandas.core.resample.Resampler.groups\
pandas.core.resample.Resampler.indices\
pandas.core.resample.Resampler.max\
pandas.core.resample.Resampler.mean\
pandas.core.resample.Resampler.median\
pandas.core.resample.Resampler.min\
pandas.core.resample.Resampler.nunique\
pandas.core.resample.Resampler.ohlc\
pandas.core.resample.Resampler.prod\
pandas.core.resample.Resampler.sem\
pandas.core.resample.Resampler.std\
pandas.core.resample.Resampler.sum\
pandas.core.resample.Resampler.transform\
pandas.core.resample.Resampler.var\
pandas.describe_option\
pandas.errors.AbstractMethodError\
pandas.errors.AttributeConflictWarning\
pandas.errors.CSSWarning\
pandas.errors.CategoricalConversionWarning\
pandas.errors.ChainedAssignmentError\
pandas.errors.ClosedFileError\
pandas.errors.DataError\
pandas.errors.DuplicateLabelError\
pandas.errors.EmptyDataError\
pandas.errors.IntCastingNaNError\
pandas.errors.InvalidIndexError\
pandas.errors.InvalidVersion\
pandas.errors.MergeError\
pandas.errors.NullFrequencyError\
pandas.errors.NumExprClobberingError\
pandas.errors.NumbaUtilError\
pandas.errors.OptionError\
pandas.errors.OutOfBoundsDatetime\
pandas.errors.OutOfBoundsTimedelta\
pandas.errors.PerformanceWarning\
pandas.errors.PossibleDataLossError\
pandas.errors.PossiblePrecisionLoss\
pandas.errors.SpecificationError\
pandas.errors.UndefinedVariableError\
pandas.errors.UnsortedIndexError\
pandas.errors.UnsupportedFunctionCall\
pandas.errors.ValueLabelTypeMismatch\
pandas.get_option\
pandas.infer_freq\
pandas.io.formats.style.Styler.bar\
pandas.io.formats.style.Styler.clear\
pandas.io.formats.style.Styler.concat\
pandas.io.formats.style.Styler.from_custom_template\
pandas.io.formats.style.Styler.hide\
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_tooltips\
pandas.io.formats.style.Styler.set_uuid\
pandas.io.formats.style.Styler.to_string\
pandas.io.json.build_table_schema\
pandas.io.stata.StataReader.data_label\
pandas.io.stata.StataReader.value_labels\
pandas.io.stata.StataReader.variable_labels\
pandas.io.stata.StataWriter.write_file\
pandas.json_normalize\
pandas.option_context\
pandas.period_range\
pandas.plotting.andrews_curves\
pandas.plotting.autocorrelation_plot\
pandas.plotting.lag_plot\
pandas.plotting.parallel_coordinates\
pandas.plotting.plot_params\
pandas.plotting.scatter_matrix\
pandas.plotting.table\
pandas.qcut\
pandas.read_feather\
pandas.read_orc\
pandas.read_sas\
pandas.read_spss\
pandas.reset_option\
pandas.set_eng_float_format\
pandas.set_option\
pandas.show_versions\
pandas.test\
pandas.testing.assert_extension_array_equal\
pandas.testing.assert_index_equal\
pandas.testing.assert_series_equal\
pandas.timedelta_range\
pandas.tseries.api.guess_datetime_format\
pandas.tseries.offsets.BDay\
pandas.tseries.offsets.BQuarterBegin.copy\
pandas.tseries.offsets.BQuarterBegin.freqstr\
pandas.tseries.offsets.BQuarterBegin.is_month_end\
pandas.tseries.offsets.BQuarterBegin.is_month_start\
pandas.tseries.offsets.BQuarterBegin.is_quarter_end\
pandas.tseries.offsets.BQuarterBegin.is_quarter_start\
pandas.tseries.offsets.BQuarterBegin.is_year_end\
pandas.tseries.offsets.BQuarterBegin.is_year_start\
pandas.tseries.offsets.BQuarterBegin.kwds\
pandas.tseries.offsets.BQuarterBegin.name\
pandas.tseries.offsets.BQuarterEnd.copy\
pandas.tseries.offsets.BQuarterEnd.freqstr\
pandas.tseries.offsets.BQuarterEnd.is_month_end\
pandas.tseries.offsets.BQuarterEnd.is_month_start\
pandas.tseries.offsets.BQuarterEnd.is_quarter_end\
pandas.tseries.offsets.BQuarterEnd.is_quarter_start\
pandas.tseries.offsets.BQuarterEnd.is_year_end\
pandas.tseries.offsets.BQuarterEnd.is_year_start\
pandas.tseries.offsets.BQuarterEnd.kwds\
pandas.tseries.offsets.BQuarterEnd.name\
pandas.tseries.offsets.BYearBegin.copy\
pandas.tseries.offsets.BYearBegin.freqstr\
pandas.tseries.offsets.BYearBegin.is_anchored\
pandas.tseries.offsets.BYearBegin.is_month_end\
pandas.tseries.offsets.BYearBegin.is_month_start\
pandas.tseries.offsets.BYearBegin.is_quarter_end\
pandas.tseries.offsets.BYearBegin.is_quarter_start\
pandas.tseries.offsets.BYearBegin.is_year_end\
pandas.tseries.offsets.BYearBegin.is_year_start\
pandas.tseries.offsets.BYearBegin.kwds\
pandas.tseries.offsets.BYearBegin.name\
pandas.tseries.offsets.BYearEnd.copy\
pandas.tseries.offsets.BYearEnd.freqstr\
pandas.tseries.offsets.BYearEnd.is_anchored\
pandas.tseries.offsets.BYearEnd.is_month_end\
pandas.tseries.offsets.BYearEnd.is_month_start\
pandas.tseries.offsets.BYearEnd.is_quarter_end\
pandas.tseries.offsets.BYearEnd.is_quarter_start\
pandas.tseries.offsets.BYearEnd.is_year_end\
pandas.tseries.offsets.BYearEnd.is_year_start\
pandas.tseries.offsets.BYearEnd.kwds\
pandas.tseries.offsets.BYearEnd.name\
pandas.tseries.offsets.BusinessDay\
pandas.tseries.offsets.BusinessDay.copy\
pandas.tseries.offsets.BusinessDay.freqstr\
pandas.tseries.offsets.BusinessDay.is_anchored\
pandas.tseries.offsets.BusinessDay.is_month_end\
pandas.tseries.offsets.BusinessDay.is_month_start\
pandas.tseries.offsets.BusinessDay.is_quarter_end\
pandas.tseries.offsets.BusinessDay.is_quarter_start\
pandas.tseries.offsets.BusinessDay.is_year_end\
pandas.tseries.offsets.BusinessDay.is_year_start\
pandas.tseries.offsets.BusinessDay.kwds\
pandas.tseries.offsets.BusinessDay.name\
pandas.tseries.offsets.BusinessHour\
pandas.tseries.offsets.BusinessHour.copy\
pandas.tseries.offsets.BusinessHour.freqstr\
pandas.tseries.offsets.BusinessHour.is_anchored\
pandas.tseries.offsets.BusinessHour.is_month_end\
pandas.tseries.offsets.BusinessHour.is_month_start\
pandas.tseries.offsets.BusinessHour.is_quarter_end\
pandas.tseries.offsets.BusinessHour.is_quarter_start\
pandas.tseries.offsets.BusinessHour.is_year_end\
pandas.tseries.offsets.BusinessHour.is_year_start\
pandas.tseries.offsets.BusinessHour.kwds\
pandas.tseries.offsets.BusinessHour.name\
pandas.tseries.offsets.BusinessMonthBegin.copy\
pandas.tseries.offsets.BusinessMonthBegin.freqstr\
pandas.tseries.offsets.BusinessMonthBegin.is_anchored\
pandas.tseries.offsets.BusinessMonthBegin.is_month_end\
pandas.tseries.offsets.BusinessMonthBegin.is_month_start\
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_end\
pandas.tseries.offsets.BusinessMonthBegin.is_quarter_start\
pandas.tseries.offsets.BusinessMonthBegin.is_year_end\
pandas.tseries.offsets.BusinessMonthBegin.is_year_start\
pandas.tseries.offsets.BusinessMonthBegin.kwds\
pandas.tseries.offsets.BusinessMonthBegin.name\
pandas.tseries.offsets.BusinessMonthEnd.copy\
pandas.tseries.offsets.BusinessMonthEnd.freqstr\
pandas.tseries.offsets.BusinessMonthEnd.is_anchored\
pandas.tseries.offsets.BusinessMonthEnd.is_month_end\
pandas.tseries.offsets.BusinessMonthEnd.is_month_start\
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_end\
pandas.tseries.offsets.BusinessMonthEnd.is_quarter_start\
pandas.tseries.offsets.BusinessMonthEnd.is_year_end\
pandas.tseries.offsets.BusinessMonthEnd.is_year_start\
pandas.tseries.offsets.BusinessMonthEnd.kwds\
pandas.tseries.offsets.BusinessMonthEnd.name\
pandas.tseries.offsets.CDay\
pandas.tseries.offsets.CustomBusinessDay\
pandas.tseries.offsets.CustomBusinessDay.copy\
pandas.tseries.offsets.CustomBusinessDay.freqstr\
pandas.tseries.offsets.CustomBusinessDay.is_anchored\
pandas.tseries.offsets.CustomBusinessDay.is_month_end\
pandas.tseries.offsets.CustomBusinessDay.is_month_start\
pandas.tseries.offsets.CustomBusinessDay.is_quarter_end\
pandas.tseries.offsets.CustomBusinessDay.is_quarter_start\
pandas.tseries.offsets.CustomBusinessDay.is_year_end\
pandas.tseries.offsets.CustomBusinessDay.is_year_start\
pandas.tseries.offsets.CustomBusinessDay.kwds\
pandas.tseries.offsets.CustomBusinessDay.name\
pandas.tseries.offsets.CustomBusinessHour\
pandas.tseries.offsets.CustomBusinessHour.copy\
pandas.tseries.offsets.CustomBusinessHour.freqstr\
pandas.tseries.offsets.CustomBusinessHour.is_anchored\
pandas.tseries.offsets.CustomBusinessHour.is_month_end\
pandas.tseries.offsets.CustomBusinessHour.is_month_start\
pandas.tseries.offsets.CustomBusinessHour.is_quarter_end\
pandas.tseries.offsets.CustomBusinessHour.is_quarter_start\
pandas.tseries.offsets.CustomBusinessHour.is_year_end\
pandas.tseries.offsets.CustomBusinessHour.is_year_start\
pandas.tseries.offsets.CustomBusinessHour.kwds\
pandas.tseries.offsets.CustomBusinessHour.name\
pandas.tseries.offsets.CustomBusinessMonthBegin.copy\
pandas.tseries.offsets.CustomBusinessMonthBegin.freqstr\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_anchored\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_month_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_on_offset\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_quarter_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_end\
pandas.tseries.offsets.CustomBusinessMonthBegin.is_year_start\
pandas.tseries.offsets.CustomBusinessMonthBegin.kwds\
pandas.tseries.offsets.CustomBusinessMonthBegin.name\
pandas.tseries.offsets.CustomBusinessMonthEnd.copy\
pandas.tseries.offsets.CustomBusinessMonthEnd.freqstr\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_anchored\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_month_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_on_offset\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_quarter_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_end\
pandas.tseries.offsets.CustomBusinessMonthEnd.is_year_start\
pandas.tseries.offsets.CustomBusinessMonthEnd.kwds\
pandas.tseries.offsets.CustomBusinessMonthEnd.name\
pandas.tseries.offsets.DateOffset.copy\
pandas.tseries.offsets.DateOffset.freqstr\
pandas.tseries.offsets.DateOffset.is_anchored\
pandas.tseries.offsets.DateOffset.is_month_end\
pandas.tseries.offsets.DateOffset.is_month_start\
pandas.tseries.offsets.DateOffset.is_quarter_end\
pandas.tseries.offsets.DateOffset.is_quarter_start\
pandas.tseries.offsets.DateOffset.is_year_end\
pandas.tseries.offsets.DateOffset.is_year_start\
pandas.tseries.offsets.DateOffset.kwds\
pandas.tseries.offsets.DateOffset.name\
pandas.tseries.offsets.Day.copy\
pandas.tseries.offsets.Day.freqstr\
pandas.tseries.offsets.Day.is_anchored\
pandas.tseries.offsets.Day.is_month_end\
pandas.tseries.offsets.Day.is_month_start\
pandas.tseries.offsets.Day.is_quarter_end\
pandas.tseries.offsets.Day.is_quarter_start\
pandas.tseries.offsets.Day.is_year_end\
pandas.tseries.offsets.Day.is_year_start\
pandas.tseries.offsets.Day.kwds\
pandas.tseries.offsets.Day.name\
pandas.tseries.offsets.Day.nanos\
pandas.tseries.offsets.Easter.copy\
pandas.tseries.offsets.Easter.freqstr\
pandas.tseries.offsets.Easter.is_anchored\
pandas.tseries.offsets.Easter.is_month_end\
pandas.tseries.offsets.Easter.is_month_start\
pandas.tseries.offsets.Easter.is_quarter_end\
pandas.tseries.offsets.Easter.is_quarter_start\
pandas.tseries.offsets.Easter.is_year_end\
pandas.tseries.offsets.Easter.is_year_start\
pandas.tseries.offsets.Easter.kwds\
pandas.tseries.offsets.Easter.name\
pandas.tseries.offsets.FY5253.copy\
pandas.tseries.offsets.FY5253.freqstr\
pandas.tseries.offsets.FY5253.is_month_end\
pandas.tseries.offsets.FY5253.is_month_start\
pandas.tseries.offsets.FY5253.is_quarter_end\
pandas.tseries.offsets.FY5253.is_quarter_start\
pandas.tseries.offsets.FY5253.is_year_end\
pandas.tseries.offsets.FY5253.is_year_start\
pandas.tseries.offsets.FY5253.kwds\
pandas.tseries.offsets.FY5253.name\
pandas.tseries.offsets.FY5253Quarter.copy\
pandas.tseries.offsets.FY5253Quarter.freqstr\
pandas.tseries.offsets.FY5253Quarter.is_month_end\
pandas.tseries.offsets.FY5253Quarter.is_month_start\
pandas.tseries.offsets.FY5253Quarter.is_quarter_end\
pandas.tseries.offsets.FY5253Quarter.is_quarter_start\
pandas.tseries.offsets.FY5253Quarter.is_year_end\
pandas.tseries.offsets.FY5253Quarter.is_year_start\
pandas.tseries.offsets.FY5253Quarter.kwds\
pandas.tseries.offsets.FY5253Quarter.name\
pandas.tseries.offsets.Hour.copy\
pandas.tseries.offsets.Hour.freqstr\
pandas.tseries.offsets.Hour.is_anchored\
pandas.tseries.offsets.Hour.is_month_end\
pandas.tseries.offsets.Hour.is_month_start\
pandas.tseries.offsets.Hour.is_quarter_end\
pandas.tseries.offsets.Hour.is_quarter_start\
pandas.tseries.offsets.Hour.is_year_end\
pandas.tseries.offsets.Hour.is_year_start\
pandas.tseries.offsets.Hour.kwds\
pandas.tseries.offsets.Hour.name\
pandas.tseries.offsets.Hour.nanos\
pandas.tseries.offsets.LastWeekOfMonth\
pandas.tseries.offsets.LastWeekOfMonth.copy\
pandas.tseries.offsets.LastWeekOfMonth.freqstr\
pandas.tseries.offsets.LastWeekOfMonth.is_anchored\
pandas.tseries.offsets.LastWeekOfMonth.is_month_end\
pandas.tseries.offsets.LastWeekOfMonth.is_month_start\
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_end\
pandas.tseries.offsets.LastWeekOfMonth.is_quarter_start\
pandas.tseries.offsets.LastWeekOfMonth.is_year_end\
pandas.tseries.offsets.LastWeekOfMonth.is_year_start\
pandas.tseries.offsets.LastWeekOfMonth.kwds\
pandas.tseries.offsets.LastWeekOfMonth.name\
pandas.tseries.offsets.Micro.copy\
pandas.tseries.offsets.Micro.freqstr\
pandas.tseries.offsets.Micro.is_anchored\
pandas.tseries.offsets.Micro.is_month_end\
pandas.tseries.offsets.Micro.is_month_start\
pandas.tseries.offsets.Micro.is_quarter_end\
pandas.tseries.offsets.Micro.is_quarter_start\
pandas.tseries.offsets.Micro.is_year_end\
pandas.tseries.offsets.Micro.is_year_start\
pandas.tseries.offsets.Micro.kwds\
pandas.tseries.offsets.Micro.name\
pandas.tseries.offsets.Micro.nanos\
pandas.tseries.offsets.Milli.copy\
pandas.tseries.offsets.Milli.freqstr\
pandas.tseries.offsets.Milli.is_anchored\
pandas.tseries.offsets.Milli.is_month_end\
pandas.tseries.offsets.Milli.is_month_start\
pandas.tseries.offsets.Milli.is_quarter_end\
pandas.tseries.offsets.Milli.is_quarter_start\
pandas.tseries.offsets.Milli.is_year_end\
pandas.tseries.offsets.Milli.is_year_start\
pandas.tseries.offsets.Milli.kwds\
pandas.tseries.offsets.Milli.name\
pandas.tseries.offsets.Milli.nanos\
pandas.tseries.offsets.Minute.copy\
pandas.tseries.offsets.Minute.freqstr\
pandas.tseries.offsets.Minute.is_anchored\
pandas.tseries.offsets.Minute.is_month_end\
pandas.tseries.offsets.Minute.is_month_start\
pandas.tseries.offsets.Minute.is_quarter_end\
pandas.tseries.offsets.Minute.is_quarter_start\
pandas.tseries.offsets.Minute.is_year_end\
pandas.tseries.offsets.Minute.is_year_start\
pandas.tseries.offsets.Minute.kwds\
pandas.tseries.offsets.Minute.name\
pandas.tseries.offsets.Minute.nanos\
pandas.tseries.offsets.MonthBegin.copy\
pandas.tseries.offsets.MonthBegin.freqstr\
pandas.tseries.offsets.MonthBegin.is_anchored\
pandas.tseries.offsets.MonthBegin.is_month_end\
pandas.tseries.offsets.MonthBegin.is_month_start\
pandas.tseries.offsets.MonthBegin.is_quarter_end\
pandas.tseries.offsets.MonthBegin.is_quarter_start\
pandas.tseries.offsets.MonthBegin.is_year_end\
pandas.tseries.offsets.MonthBegin.is_year_start\
pandas.tseries.offsets.MonthBegin.kwds\
pandas.tseries.offsets.MonthBegin.name\
pandas.tseries.offsets.MonthEnd.copy\
pandas.tseries.offsets.MonthEnd.freqstr\
pandas.tseries.offsets.MonthEnd.is_anchored\
pandas.tseries.offsets.MonthEnd.is_month_end\
pandas.tseries.offsets.MonthEnd.is_month_start\
pandas.tseries.offsets.MonthEnd.is_quarter_end\
pandas.tseries.offsets.MonthEnd.is_quarter_start\
pandas.tseries.offsets.MonthEnd.is_year_end\
pandas.tseries.offsets.MonthEnd.is_year_start\
pandas.tseries.offsets.MonthEnd.kwds\
pandas.tseries.offsets.MonthEnd.name\
pandas.tseries.offsets.Nano.copy\
pandas.tseries.offsets.Nano.freqstr\
pandas.tseries.offsets.Nano.is_anchored\
pandas.tseries.offsets.Nano.is_month_end\
pandas.tseries.offsets.Nano.is_month_start\
pandas.tseries.offsets.Nano.is_quarter_end\
pandas.tseries.offsets.Nano.is_quarter_start\
pandas.tseries.offsets.Nano.is_year_end\
pandas.tseries.offsets.Nano.is_year_start\
pandas.tseries.offsets.Nano.kwds\
pandas.tseries.offsets.Nano.name\
pandas.tseries.offsets.Nano.nanos\
pandas.tseries.offsets.QuarterBegin.copy\
pandas.tseries.offsets.QuarterBegin.freqstr\
pandas.tseries.offsets.QuarterBegin.is_month_end\
pandas.tseries.offsets.QuarterBegin.is_month_start\
pandas.tseries.offsets.QuarterBegin.is_quarter_end\
pandas.tseries.offsets.QuarterBegin.is_quarter_start\
pandas.tseries.offsets.QuarterBegin.is_year_end\
pandas.tseries.offsets.QuarterBegin.is_year_start\
pandas.tseries.offsets.QuarterBegin.kwds\
pandas.tseries.offsets.QuarterBegin.name\
pandas.tseries.offsets.QuarterEnd.copy\
pandas.tseries.offsets.QuarterEnd.freqstr\
pandas.tseries.offsets.QuarterEnd.is_month_end\
pandas.tseries.offsets.QuarterEnd.is_month_start\
pandas.tseries.offsets.QuarterEnd.is_quarter_end\
pandas.tseries.offsets.QuarterEnd.is_quarter_start\
pandas.tseries.offsets.QuarterEnd.is_year_end\
pandas.tseries.offsets.QuarterEnd.is_year_start\
pandas.tseries.offsets.QuarterEnd.kwds\
pandas.tseries.offsets.QuarterEnd.name\
pandas.tseries.offsets.Second.copy\
pandas.tseries.offsets.Second.freqstr\
pandas.tseries.offsets.Second.is_anchored\
pandas.tseries.offsets.Second.is_month_end\
pandas.tseries.offsets.Second.is_month_start\
pandas.tseries.offsets.Second.is_quarter_end\
pandas.tseries.offsets.Second.is_quarter_start\
pandas.tseries.offsets.Second.is_year_end\
pandas.tseries.offsets.Second.is_year_start\
pandas.tseries.offsets.Second.kwds\
pandas.tseries.offsets.Second.name\
pandas.tseries.offsets.Second.nanos\
pandas.tseries.offsets.SemiMonthBegin\
pandas.tseries.offsets.SemiMonthBegin.copy\
pandas.tseries.offsets.SemiMonthBegin.freqstr\
pandas.tseries.offsets.SemiMonthBegin.is_anchored\
pandas.tseries.offsets.SemiMonthBegin.is_month_end\
pandas.tseries.offsets.SemiMonthBegin.is_month_start\
pandas.tseries.offsets.SemiMonthBegin.is_quarter_end\
pandas.tseries.offsets.SemiMonthBegin.is_quarter_start\
pandas.tseries.offsets.SemiMonthBegin.is_year_end\
pandas.tseries.offsets.SemiMonthBegin.is_year_start\
pandas.tseries.offsets.SemiMonthBegin.kwds\
pandas.tseries.offsets.SemiMonthBegin.name\
pandas.tseries.offsets.SemiMonthEnd\
pandas.tseries.offsets.SemiMonthEnd.copy\
pandas.tseries.offsets.SemiMonthEnd.freqstr\
pandas.tseries.offsets.SemiMonthEnd.is_anchored\
pandas.tseries.offsets.SemiMonthEnd.is_month_end\
pandas.tseries.offsets.SemiMonthEnd.is_month_start\
pandas.tseries.offsets.SemiMonthEnd.is_quarter_end\
pandas.tseries.offsets.SemiMonthEnd.is_quarter_start\
pandas.tseries.offsets.SemiMonthEnd.is_year_end\
pandas.tseries.offsets.SemiMonthEnd.is_year_start\
pandas.tseries.offsets.SemiMonthEnd.kwds\
pandas.tseries.offsets.SemiMonthEnd.name\
pandas.tseries.offsets.Tick.copy\
pandas.tseries.offsets.Tick.freqstr\
pandas.tseries.offsets.Tick.is_anchored\
pandas.tseries.offsets.Tick.is_month_end\
pandas.tseries.offsets.Tick.is_month_start\
pandas.tseries.offsets.Tick.is_quarter_end\
pandas.tseries.offsets.Tick.is_quarter_start\
pandas.tseries.offsets.Tick.is_year_end\
pandas.tseries.offsets.Tick.is_year_start\
pandas.tseries.offsets.Tick.kwds\
pandas.tseries.offsets.Tick.name\
pandas.tseries.offsets.Tick.nanos\
pandas.tseries.offsets.Week.copy\
pandas.tseries.offsets.Week.freqstr\
pandas.tseries.offsets.Week.is_month_end\
pandas.tseries.offsets.Week.is_month_start\
pandas.tseries.offsets.Week.is_quarter_end\
pandas.tseries.offsets.Week.is_quarter_start\
pandas.tseries.offsets.Week.is_year_end\
pandas.tseries.offsets.Week.is_year_start\
pandas.tseries.offsets.Week.kwds\
pandas.tseries.offsets.Week.name\
pandas.tseries.offsets.WeekOfMonth\
pandas.tseries.offsets.WeekOfMonth.copy\
pandas.tseries.offsets.WeekOfMonth.freqstr\
pandas.tseries.offsets.WeekOfMonth.is_anchored\
pandas.tseries.offsets.WeekOfMonth.is_month_end\
pandas.tseries.offsets.WeekOfMonth.is_month_start\
pandas.tseries.offsets.WeekOfMonth.is_quarter_end\
pandas.tseries.offsets.WeekOfMonth.is_quarter_start\
pandas.tseries.offsets.WeekOfMonth.is_year_end\
pandas.tseries.offsets.WeekOfMonth.is_year_start\
pandas.tseries.offsets.WeekOfMonth.kwds\
pandas.tseries.offsets.WeekOfMonth.name\
pandas.tseries.offsets.YearBegin.copy\
pandas.tseries.offsets.YearBegin.freqstr\
pandas.tseries.offsets.YearBegin.is_anchored\
pandas.tseries.offsets.YearBegin.is_month_end\
pandas.tseries.offsets.YearBegin.is_month_start\
pandas.tseries.offsets.YearBegin.is_quarter_end\
pandas.tseries.offsets.YearBegin.is_quarter_start\
pandas.tseries.offsets.YearBegin.is_year_end\
pandas.tseries.offsets.YearBegin.is_year_start\
pandas.tseries.offsets.YearBegin.kwds\
pandas.tseries.offsets.YearBegin.name\
pandas.tseries.offsets.YearEnd.copy\
pandas.tseries.offsets.YearEnd.freqstr\
pandas.tseries.offsets.YearEnd.is_anchored\
pandas.tseries.offsets.YearEnd.is_month_end\
pandas.tseries.offsets.YearEnd.is_month_start\
pandas.tseries.offsets.YearEnd.is_quarter_end\
pandas.tseries.offsets.YearEnd.is_quarter_start\
pandas.tseries.offsets.YearEnd.is_year_end\
pandas.tseries.offsets.YearEnd.is_year_start\
pandas.tseries.offsets.YearEnd.kwds\
pandas.tseries.offsets.YearEnd.name\
pandas.util.hash_array\
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 SA01 check.

The task here is:

  • take 2-4 methods
  • run: scripts/validate_docstrings.py --format=actions --errors=SA01 method-name
  • check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
  • remove those methods from code_checks.sh
  • 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 #57354

@jordan-d-murphy
Copy link
Contributor Author

opened up a fix for pandas.ArrowDtype

@jordan-d-murphy
Copy link
Contributor Author

opened a fix for

pandas.BooleanDtype
pandas.StringDtype

@jordan-d-murphy
Copy link
Contributor Author

opened a fix for the following:

pandas.Categorical.as_ordered
pandas.Categorical.as_unordered
pandas.CategoricalIndex.as_ordered
pandas.CategoricalIndex.as_unordered
pandas.Series.cat.as_ordered
pandas.Series.cat.as_unordered

@jordan-d-murphy
Copy link
Contributor Author

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

@jordan-d-murphy
Copy link
Contributor Author

@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
Labels
Projects
None yet
Development

No branches or pull requests

2 participants