DOC: Fix EX01 issues in docstrings #37875

lucasrodes · 2020-11-15T21:29:59Z

Location of the documentation

In various pandas modules. See list below for the complete list of functions raising EX01 errors.

Documentation problem

The listed functions are missing the example section, i.e. code EX01.

Current errors:

see the list here

pandas/ci/code_checks.sh

Lines 86 to 578 in 77e97d2

    
           MSG='Partially validate docstrings (EX01)' ; echo $MSG 
        
           $BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=EX01 --ignore_functions \ 
        
               pandas.Series.index \ 
        
               pandas.Series.dtype \ 
        
               pandas.Series.shape \ 
        
               pandas.Series.nbytes \ 
        
               pandas.Series.ndim \ 
        
               pandas.Series.size \ 
        
               pandas.Series.T \ 
        
               pandas.Series.hasnans \ 
        
               pandas.Series.dtypes \ 
        
               pandas.Series.to_period \ 
        
               pandas.Series.to_timestamp \ 
        
               pandas.Series.to_list \ 
        
               pandas.Series.__iter__ \ 
        
               pandas.Series.keys \ 
        
               pandas.Series.item \ 
        
               pandas.Series.pipe \ 
        
               pandas.Series.kurt \ 
        
               pandas.Series.mean \ 
        
               pandas.Series.median \ 
        
               pandas.Series.mode \ 
        
               pandas.Series.sem \ 
        
               pandas.Series.skew \ 
        
               pandas.Series.kurtosis \ 
        
               pandas.Series.is_unique \ 
        
               pandas.Series.is_monotonic_increasing \ 
        
               pandas.Series.is_monotonic_decreasing \ 
        
               pandas.Series.backfill \ 
        
               pandas.Series.pad \ 
        
               pandas.Series.argsort \ 
        
               pandas.Series.reorder_levels \ 
        
               pandas.Series.ravel \ 
        
               pandas.Series.first_valid_index \ 
        
               pandas.Series.last_valid_index \ 
        
               pandas.Series.dt.date \ 
        
               pandas.Series.dt.time \ 
        
               pandas.Series.dt.timetz \ 
        
               pandas.Series.dt.dayofyear \ 
        
               pandas.Series.dt.day_of_year \ 
        
               pandas.Series.dt.quarter \ 
        
               pandas.Series.dt.daysinmonth \ 
        
               pandas.Series.dt.days_in_month \ 
        
               pandas.Series.dt.tz \ 
        
               pandas.Series.dt.end_time \ 
        
               pandas.Series.dt.days \ 
        
               pandas.Series.dt.seconds \ 
        
               pandas.Series.dt.microseconds \ 
        
               pandas.Series.dt.nanoseconds \ 
        
               pandas.Series.str.center \ 
        
               pandas.Series.str.decode \ 
        
               pandas.Series.str.encode \ 
        
               pandas.Series.str.find \ 
        
               pandas.Series.str.fullmatch \ 
        
               pandas.Series.str.index \ 
        
               pandas.Series.str.ljust \ 
        
               pandas.Series.str.match \ 
        
               pandas.Series.str.normalize \ 
        
               pandas.Series.str.rfind \ 
        
               pandas.Series.str.rindex \ 
        
               pandas.Series.str.rjust \ 
        
               pandas.Series.str.translate \ 
        
               pandas.Series.sparse \ 
        
               pandas.DataFrame.sparse \ 
        
               pandas.Series.cat.categories \ 
        
               pandas.Series.cat.ordered \ 
        
               pandas.Series.cat.codes \ 
        
               pandas.Series.cat.reorder_categories \ 
        
               pandas.Series.cat.set_categories \ 
        
               pandas.Series.cat.as_ordered \ 
        
               pandas.Series.cat.as_unordered \ 
        
               pandas.Series.sparse.fill_value \ 
        
               pandas.Flags \ 
        
               pandas.Series.attrs \ 
        
               pandas.Series.plot \ 
        
               pandas.Series.hist \ 
        
               pandas.Series.to_string \ 
        
               pandas.errors.AbstractMethodError \ 
        
               pandas.errors.AccessorRegistrationWarning \ 
        
               pandas.errors.AttributeConflictWarning \ 
        
               pandas.errors.DataError \ 
        
               pandas.errors.EmptyDataError \ 
        
               pandas.errors.IncompatibilityWarning \ 
        
               pandas.errors.InvalidComparison \ 
        
               pandas.errors.InvalidIndexError \ 
        
               pandas.errors.InvalidVersion \ 
        
               pandas.errors.IntCastingNaNError \ 
        
               pandas.errors.LossySetitemError \ 
        
               pandas.errors.MergeError \ 
        
               pandas.errors.NoBufferPresent \ 
        
               pandas.errors.NullFrequencyError \ 
        
               pandas.errors.NumbaUtilError \ 
        
               pandas.errors.OptionError \ 
        
               pandas.errors.OutOfBoundsDatetime \ 
        
               pandas.errors.OutOfBoundsTimedelta \ 
        
               pandas.errors.ParserError \ 
        
               pandas.errors.PerformanceWarning \ 
        
               pandas.errors.PyperclipException \ 
        
               pandas.errors.PyperclipWindowsException \ 
        
               pandas.errors.UnsortedIndexError \ 
        
               pandas.errors.UnsupportedFunctionCall \ 
        
               pandas.show_versions \ 
        
               pandas.test \ 
        
               pandas.NaT \ 
        
               pandas.Timestamp.unit \ 
        
               pandas.Timestamp.as_unit \ 
        
               pandas.Timestamp.ctime \ 
        
               pandas.Timestamp.date \ 
        
               pandas.Timestamp.dst \ 
        
               pandas.Timestamp.isocalendar \ 
        
               pandas.Timestamp.isoweekday \ 
        
               pandas.Timestamp.strptime \ 
        
               pandas.Timestamp.time \ 
        
               pandas.Timestamp.timetuple \ 
        
               pandas.Timestamp.timetz \ 
        
               pandas.Timestamp.to_datetime64 \ 
        
               pandas.Timestamp.toordinal \ 
        
               pandas.Timestamp.tzname \ 
        
               pandas.Timestamp.utcoffset \ 
        
               pandas.Timestamp.utctimetuple \ 
        
               pandas.Timestamp.weekday \ 
        
               pandas.arrays.DatetimeArray \ 
        
               pandas.Timedelta.components \ 
        
               pandas.Timedelta.view \ 
        
               pandas.Timedelta.as_unit \ 
        
               pandas.Timedelta.ceil \ 
        
               pandas.Timedelta.floor \ 
        
               pandas.Timedelta.round \ 
        
               pandas.Timedelta.to_pytimedelta \ 
        
               pandas.Timedelta.to_timedelta64 \ 
        
               pandas.Timedelta.to_numpy \ 
        
               pandas.Timedelta.total_seconds \ 
        
               pandas.arrays.TimedeltaArray \ 
        
               pandas.Period.end_time \ 
        
               pandas.Period.freqstr \ 
        
               pandas.Period.is_leap_year \ 
        
               pandas.Period.month \ 
        
               pandas.Period.quarter \ 
        
               pandas.Period.year \ 
        
               pandas.Period.asfreq \ 
        
               pandas.Period.now \ 
        
               pandas.Period.to_timestamp \ 
        
               pandas.arrays.PeriodArray \ 
        
               pandas.Interval.closed \ 
        
               pandas.Interval.left \ 
        
               pandas.Interval.length \ 
        
               pandas.Interval.right \ 
        
               pandas.arrays.IntervalArray.left \ 
        
               pandas.arrays.IntervalArray.right \ 
        
               pandas.arrays.IntervalArray.closed \ 
        
               pandas.arrays.IntervalArray.mid \ 
        
               pandas.arrays.IntervalArray.length \ 
        
               pandas.arrays.IntervalArray.is_non_overlapping_monotonic \ 
        
               pandas.arrays.IntervalArray.from_arrays \ 
        
               pandas.arrays.IntervalArray.to_tuples \ 
        
               pandas.Int8Dtype \ 
        
               pandas.Int16Dtype \ 
        
               pandas.Int32Dtype \ 
        
               pandas.Int64Dtype \ 
        
               pandas.UInt8Dtype \ 
        
               pandas.UInt16Dtype \ 
        
               pandas.UInt32Dtype \ 
        
               pandas.UInt64Dtype \ 
        
               pandas.NA \ 
        
               pandas.Float32Dtype \ 
        
               pandas.Float64Dtype \ 
        
               pandas.CategoricalDtype.categories \ 
        
               pandas.CategoricalDtype.ordered \ 
        
               pandas.Categorical.dtype \ 
        
               pandas.Categorical.categories \ 
        
               pandas.Categorical.ordered \ 
        
               pandas.Categorical.codes \ 
        
               pandas.Categorical.__array__ \ 
        
               pandas.SparseDtype \ 
        
               pandas.DatetimeTZDtype.unit \ 
        
               pandas.DatetimeTZDtype.tz \ 
        
               pandas.PeriodDtype.freq \ 
        
               pandas.IntervalDtype.subtype \ 
        
               pandas_dtype \ 
        
               pandas.api.types.is_bool \ 
        
               pandas.api.types.is_complex \ 
        
               pandas.api.types.is_float \ 
        
               pandas.api.types.is_integer \ 
        
               pandas.api.types.pandas_dtype \ 
        
               pandas.read_clipboard \ 
        
               pandas.ExcelFile.parse \ 
        
               pandas.DataFrame.to_html \ 
        
               pandas.io.formats.style.Styler.to_html \ 
        
               pandas.HDFStore.put \ 
        
               pandas.HDFStore.append \ 
        
               pandas.HDFStore.get \ 
        
               pandas.HDFStore.select \ 
        
               pandas.HDFStore.info \ 
        
               pandas.HDFStore.keys \ 
        
               pandas.HDFStore.groups \ 
        
               pandas.HDFStore.walk \ 
        
               pandas.read_feather \ 
        
               pandas.DataFrame.to_feather \ 
        
               pandas.read_parquet \ 
        
               pandas.read_orc \ 
        
               pandas.read_sas \ 
        
               pandas.read_spss \ 
        
               pandas.read_sql_query \ 
        
               pandas.read_gbq \ 
        
               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.core.resample.Resampler.__iter__ \ 
        
               pandas.core.resample.Resampler.groups \ 
        
               pandas.core.resample.Resampler.indices \ 
        
               pandas.core.resample.Resampler.get_group \ 
        
               pandas.core.resample.Resampler.ffill \ 
        
               pandas.core.resample.Resampler.asfreq \ 
        
               pandas.core.resample.Resampler.count \ 
        
               pandas.core.resample.Resampler.nunique \ 
        
               pandas.core.resample.Resampler.max \ 
        
               pandas.core.resample.Resampler.mean \ 
        
               pandas.core.resample.Resampler.median \ 
        
               pandas.core.resample.Resampler.min \ 
        
               pandas.core.resample.Resampler.ohlc \ 
        
               pandas.core.resample.Resampler.prod \ 
        
               pandas.core.resample.Resampler.size \ 
        
               pandas.core.resample.Resampler.sem \ 
        
               pandas.core.resample.Resampler.std \ 
        
               pandas.core.resample.Resampler.sum \ 
        
               pandas.core.resample.Resampler.var \ 
        
               pandas.core.resample.Resampler.quantile \ 
        
               pandas.describe_option \ 
        
               pandas.reset_option \ 
        
               pandas.get_option \ 
        
               pandas.set_option \ 
        
               pandas.plotting.deregister_matplotlib_converters \ 
        
               pandas.plotting.plot_params \ 
        
               pandas.plotting.register_matplotlib_converters \ 
        
               pandas.plotting.table \ 
        
               pandas.util.hash_array \ 
        
               pandas.util.hash_pandas_object \ 
        
               pandas_object \ 
        
               pandas.api.interchange.from_dataframe \ 
        
               pandas.Index.values \ 
        
               pandas.Index.hasnans \ 
        
               pandas.Index.dtype \ 
        
               pandas.Index.inferred_type \ 
        
               pandas.Index.shape \ 
        
               pandas.Index.name \ 
        
               pandas.Index.nbytes \ 
        
               pandas.Index.ndim \ 
        
               pandas.Index.size \ 
        
               pandas.Index.T \ 
        
               pandas.Index.memory_usage \ 
        
               pandas.Index.copy \ 
        
               pandas.Index.drop \ 
        
               pandas.Index.identical \ 
        
               pandas.Index.insert \ 
        
               pandas.Index.is_ \ 
        
               pandas.Index.take \ 
        
               pandas.Index.putmask \ 
        
               pandas.Index.unique \ 
        
               pandas.Index.fillna \ 
        
               pandas.Index.dropna \ 
        
               pandas.Index.astype \ 
        
               pandas.Index.item \ 
        
               pandas.Index.map \ 
        
               pandas.Index.ravel \ 
        
               pandas.Index.to_list \ 
        
               pandas.Index.append \ 
        
               pandas.Index.join \ 
        
               pandas.Index.asof_locs \ 
        
               pandas.Index.get_slice_bound \ 
        
               pandas.RangeIndex \ 
        
               pandas.RangeIndex.start \ 
        
               pandas.RangeIndex.stop \ 
        
               pandas.RangeIndex.step \ 
        
               pandas.RangeIndex.from_range \ 
        
               pandas.CategoricalIndex.codes \ 
        
               pandas.CategoricalIndex.categories \ 
        
               pandas.CategoricalIndex.ordered \ 
        
               pandas.CategoricalIndex.reorder_categories \ 
        
               pandas.CategoricalIndex.set_categories \ 
        
               pandas.CategoricalIndex.as_ordered \ 
        
               pandas.CategoricalIndex.as_unordered \ 
        
               pandas.CategoricalIndex.equals \ 
        
               pandas.IntervalIndex.closed \ 
        
               pandas.IntervalIndex.values \ 
        
               pandas.IntervalIndex.is_non_overlapping_monotonic \ 
        
               pandas.IntervalIndex.to_tuples \ 
        
               pandas.MultiIndex.dtypes \ 
        
               pandas.MultiIndex.drop \ 
        
               pandas.DatetimeIndex \ 
        
               pandas.DatetimeIndex.date \ 
        
               pandas.DatetimeIndex.time \ 
        
               pandas.DatetimeIndex.timetz \ 
        
               pandas.DatetimeIndex.dayofyear \ 
        
               pandas.DatetimeIndex.day_of_year \ 
        
               pandas.DatetimeIndex.quarter \ 
        
               pandas.DatetimeIndex.tz \ 
        
               pandas.DatetimeIndex.freqstr \ 
        
               pandas.DatetimeIndex.inferred_freq \ 
        
               pandas.DatetimeIndex.indexer_at_time \ 
        
               pandas.DatetimeIndex.indexer_between_time \ 
        
               pandas.DatetimeIndex.snap \ 
        
               pandas.DatetimeIndex.as_unit \ 
        
               pandas.DatetimeIndex.to_pydatetime \ 
        
               pandas.DatetimeIndex.to_series \ 
        
               pandas.DatetimeIndex.mean \ 
        
               pandas.DatetimeIndex.std \ 
        
               pandas.TimedeltaIndex \ 
        
               pandas.TimedeltaIndex.days \ 
        
               pandas.TimedeltaIndex.seconds \ 
        
               pandas.TimedeltaIndex.microseconds \ 
        
               pandas.TimedeltaIndex.nanoseconds \ 
        
               pandas.TimedeltaIndex.components \ 
        
               pandas.TimedeltaIndex.inferred_freq \ 
        
               pandas.TimedeltaIndex.as_unit \ 
        
               pandas.TimedeltaIndex.to_pytimedelta \ 
        
               pandas.TimedeltaIndex.mean \ 
        
               pandas.PeriodIndex.day \ 
        
               pandas.PeriodIndex.dayofweek \ 
        
               pandas.PeriodIndex.day_of_week \ 
        
               pandas.PeriodIndex.dayofyear \ 
        
               pandas.PeriodIndex.day_of_year \ 
        
               pandas.PeriodIndex.days_in_month \ 
        
               pandas.PeriodIndex.daysinmonth \ 
        
               pandas.PeriodIndex.end_time \ 
        
               pandas.PeriodIndex.freqstr \ 
        
               pandas.PeriodIndex.hour \ 
        
               pandas.PeriodIndex.is_leap_year \ 
        
               pandas.PeriodIndex.minute \ 
        
               pandas.PeriodIndex.month \ 
        
               pandas.PeriodIndex.quarter \ 
        
               pandas.PeriodIndex.second \ 
        
               pandas.PeriodIndex.week \ 
        
               pandas.PeriodIndex.weekday \ 
        
               pandas.PeriodIndex.weekofyear \ 
        
               pandas.PeriodIndex.year \ 
        
               pandas.PeriodIndex.to_timestamp \ 
        
               pandas.core.window.rolling.Rolling.max \ 
        
               pandas.core.window.rolling.Rolling.cov \ 
        
               pandas.core.window.rolling.Rolling.skew \ 
        
               pandas.core.window.rolling.Rolling.apply \ 
        
               pandas.core.window.rolling.Window.mean \ 
        
               pandas.core.window.rolling.Window.sum \ 
        
               pandas.core.window.rolling.Window.var \ 
        
               pandas.core.window.rolling.Window.std \ 
        
               pandas.core.window.expanding.Expanding.count \ 
        
               pandas.core.window.expanding.Expanding.sum \ 
        
               pandas.core.window.expanding.Expanding.mean \ 
        
               pandas.core.window.expanding.Expanding.median \ 
        
               pandas.core.window.expanding.Expanding.min \ 
        
               pandas.core.window.expanding.Expanding.max \ 
        
               pandas.core.window.expanding.Expanding.corr \ 
        
               pandas.core.window.expanding.Expanding.cov \ 
        
               pandas.core.window.expanding.Expanding.skew \ 
        
               pandas.core.window.expanding.Expanding.apply \ 
        
               pandas.core.window.expanding.Expanding.quantile \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.mean \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.sum \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.std \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.var \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.corr \ 
        
               pandas.core.window.ewm.ExponentialMovingWindow.cov \ 
        
               pandas.api.indexers.BaseIndexer \ 
        
               pandas.api.indexers.VariableOffsetWindowIndexer \ 
        
               pandas.core.groupby.DataFrameGroupBy.__iter__ \ 
        
               pandas.core.groupby.SeriesGroupBy.__iter__ \ 
        
               pandas.core.groupby.DataFrameGroupBy.groups \ 
        
               pandas.core.groupby.SeriesGroupBy.groups \ 
        
               pandas.core.groupby.DataFrameGroupBy.indices \ 
        
               pandas.core.groupby.SeriesGroupBy.indices \ 
        
               pandas.core.groupby.DataFrameGroupBy.get_group \ 
        
               pandas.core.groupby.SeriesGroupBy.get_group \ 
        
               pandas.core.groupby.DataFrameGroupBy.all \ 
        
               pandas.core.groupby.DataFrameGroupBy.any \ 
        
               pandas.core.groupby.DataFrameGroupBy.bfill \ 
        
               pandas.core.groupby.DataFrameGroupBy.count \ 
        
               pandas.core.groupby.DataFrameGroupBy.cummax \ 
        
               pandas.core.groupby.DataFrameGroupBy.cummin \ 
        
               pandas.core.groupby.DataFrameGroupBy.cumprod \ 
        
               pandas.core.groupby.DataFrameGroupBy.cumsum \ 
        
               pandas.core.groupby.DataFrameGroupBy.diff \ 
        
               pandas.core.groupby.DataFrameGroupBy.ffill \ 
        
               pandas.core.groupby.DataFrameGroupBy.max \ 
        
               pandas.core.groupby.DataFrameGroupBy.median \ 
        
               pandas.core.groupby.DataFrameGroupBy.min \ 
        
               pandas.core.groupby.DataFrameGroupBy.ohlc \ 
        
               pandas.core.groupby.DataFrameGroupBy.pct_change \ 
        
               pandas.core.groupby.DataFrameGroupBy.prod \ 
        
               pandas.core.groupby.DataFrameGroupBy.sem \ 
        
               pandas.core.groupby.DataFrameGroupBy.shift \ 
        
               pandas.core.groupby.DataFrameGroupBy.size \ 
        
               pandas.core.groupby.DataFrameGroupBy.skew \ 
        
               pandas.core.groupby.DataFrameGroupBy.std \ 
        
               pandas.core.groupby.DataFrameGroupBy.sum \ 
        
               pandas.core.groupby.DataFrameGroupBy.var \ 
        
               pandas.core.groupby.SeriesGroupBy.all \ 
        
               pandas.core.groupby.SeriesGroupBy.any \ 
        
               pandas.core.groupby.SeriesGroupBy.bfill \ 
        
               pandas.core.groupby.SeriesGroupBy.count \ 
        
               pandas.core.groupby.SeriesGroupBy.cummax \ 
        
               pandas.core.groupby.SeriesGroupBy.cummin \ 
        
               pandas.core.groupby.SeriesGroupBy.cumprod \ 
        
               pandas.core.groupby.SeriesGroupBy.cumsum \ 
        
               pandas.core.groupby.SeriesGroupBy.diff \ 
        
               pandas.core.groupby.SeriesGroupBy.ffill \ 
        
               pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing \ 
        
               pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing \ 
        
               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.pct_change \ 
        
               pandas.core.groupby.SeriesGroupBy.prod \ 
        
               pandas.core.groupby.SeriesGroupBy.sem \ 
        
               pandas.core.groupby.SeriesGroupBy.shift \ 
        
               pandas.core.groupby.SeriesGroupBy.size \ 
        
               pandas.core.groupby.SeriesGroupBy.skew \ 
        
               pandas.core.groupby.SeriesGroupBy.std \ 
        
               pandas.core.groupby.SeriesGroupBy.sum \ 
        
               pandas.core.groupby.SeriesGroupBy.var \ 
        
               pandas.core.groupby.SeriesGroupBy.hist \ 
        
               pandas.core.groupby.DataFrameGroupBy.plot \ 
        
               pandas.core.groupby.SeriesGroupBy.plot \ 
        
               pandas.io.formats.style.Styler \ 
        
               pandas.io.formats.style.Styler.from_custom_template \ 
        
               pandas.io.formats.style.Styler.set_caption \ 
        
               pandas.io.formats.style.Styler.set_sticky \ 
        
               pandas.io.formats.style.Styler.set_uuid \ 
        
               pandas.io.formats.style.Styler.clear \ 
        
               pandas.io.formats.style.Styler.highlight_null \ 
        
               pandas.io.formats.style.Styler.highlight_max \ 
        
               pandas.io.formats.style.Styler.highlight_min \ 
        
               pandas.io.formats.style.Styler.bar \ 
        
               pandas.io.formats.style.Styler.to_string \ 
        
               pandas.api.extensions.ExtensionDtype \ 
        
               pandas.api.extensions.ExtensionArray \ 
        
               pandas.arrays.PandasArray \ 
        
               pandas.api.extensions.ExtensionArray._accumulate \ 
        
               pandas.api.extensions.ExtensionArray._concat_same_type \ 
        
               pandas.api.extensions.ExtensionArray._formatter \ 
        
               pandas.api.extensions.ExtensionArray._from_factorized \ 
        
               pandas.api.extensions.ExtensionArray._from_sequence \ 
        
               pandas.api.extensions.ExtensionArray._from_sequence_of_strings \ 
        
               pandas.api.extensions.ExtensionArray._reduce \ 
        
               pandas.api.extensions.ExtensionArray._values_for_argsort \ 
        
               pandas.api.extensions.ExtensionArray._values_for_factorize \ 
        
               pandas.api.extensions.ExtensionArray.argsort \ 
        
               pandas.api.extensions.ExtensionArray.astype \ 
        
               pandas.api.extensions.ExtensionArray.copy \ 
        
               pandas.api.extensions.ExtensionArray.view \ 
        
               pandas.api.extensions.ExtensionArray.dropna \ 
        
               pandas.api.extensions.ExtensionArray.equals \ 
        
               pandas.api.extensions.ExtensionArray.factorize \ 
        
               pandas.api.extensions.ExtensionArray.fillna \ 
        
               pandas.api.extensions.ExtensionArray.insert \ 
        
               pandas.api.extensions.ExtensionArray.isin \ 
        
               pandas.api.extensions.ExtensionArray.isna \ 
        
               pandas.api.extensions.ExtensionArray.ravel \ 
        
               pandas.api.extensions.ExtensionArray.searchsorted \ 
        
               pandas.api.extensions.ExtensionArray.shift \ 
        
               pandas.api.extensions.ExtensionArray.unique \ 
        
               pandas.api.extensions.ExtensionArray.dtype \ 
        
               pandas.api.extensions.ExtensionArray.nbytes \ 
        
               pandas.api.extensions.ExtensionArray.ndim \ 
        
               pandas.api.extensions.ExtensionArray.shape \ 
        
               pandas.api.extensions.ExtensionArray.tolist \ 
        
               pandas.DataFrame.index \ 
        
               pandas.DataFrame.columns \ 
        
               pandas.DataFrame.__iter__ \ 
        
               pandas.DataFrame.keys \ 
        
               pandas.DataFrame.iterrows \ 
        
               pandas.DataFrame.pipe \ 
        
               pandas.DataFrame.kurt \ 
        
               pandas.DataFrame.kurtosis \ 
        
               pandas.DataFrame.mean \ 
        
               pandas.DataFrame.median \ 
        
               pandas.DataFrame.sem \ 
        
               pandas.DataFrame.skew \ 
        
               pandas.DataFrame.backfill \ 
        
               pandas.DataFrame.pad \ 
        
               pandas.DataFrame.swapaxes \ 
        
               pandas.DataFrame.first_valid_index \ 
        
               pandas.DataFrame.last_valid_index \ 
        
               pandas.DataFrame.to_timestamp \ 
        
               pandas.DataFrame.attrs \ 
        
               pandas.DataFrame.plot \ 
        
               pandas.DataFrame.sparse.density \ 
        
               pandas.DataFrame.sparse.to_coo \ 
        
               pandas.DataFrame.to_gbq \ 
        
               pandas.DataFrame.style \ 
        
               pandas.DataFrame.__dataframe__ \ 
        
           RET=$(($RET + $?)) ; echo $MSG "DONE"

When you work on this issue, please choose a handful of functions, fix them up, and remove them from the exclusions list above

lucasrodes · 2020-11-15T21:42:18Z

I'll take all pandas.Timestamp related.

xinrong-meng · 2020-11-22T01:03:30Z

I'll take all pandas.MultiIndex related.

xinrong-meng · 2020-11-28T22:24:57Z

Out of curiosity, do types below need examples in docstrings?

 pandas.Int8Dtype
 pandas.Int16Dtype
 pandas.Int32Dtype
 pandas.Int64Dtype
 pandas.UInt8Dtype
 pandas.UInt16Dtype
 pandas.UInt32Dtype
 pandas.UInt64Dtype

lucasrodes · 2020-11-29T15:50:33Z

Hi @xinrong-databricks,

Out of curiosity, do types below need examples in docstrings?

 pandas.Int8Dtype
 pandas.Int16Dtype
 pandas.Int32Dtype
 pandas.Int64Dtype
 pandas.UInt8Dtype
 pandas.UInt16Dtype
 pandas.UInt32Dtype
 pandas.UInt64Dtype

I have seen that other dtype classes (StringDtype CategoricalDtype, DatetimeTZDtype, ...) do have an Example section, so perhaps an example in the dtypes you mention could also be meaningful.

Nevertheless, modifying de docstrings in these classes might require a change in string variable _dtype_docstring, so the PR might be a bit more complex. Similar cases are Float32Dtype and Float64Dtype.

xinrong-meng · 2020-11-30T17:11:43Z

Hi @lucasrodes, that really makes sense. Thank you for your clear explanations!

TheNeuralBit · 2021-03-03T20:17:24Z

It looks like GroupBy.apply example section was unintentionally removed here: https://github.com/pandas-dev/pandas/pull/24126/files#diff-db4158473de1d73771c56100a135f2bb80b2b29e2b573a763781a1a25e69c6dc

I can send a patch to add it back.

MarcoGorelli · 2023-01-31T17:43:37Z

I've opened an example of how to make PRs for this issue now: #51091

Before submitting, you should run (replace pandas.Timestamp.unit with your functions)

python scripts/validate_docstrings.py pandas.Timestamp.unit

and check that No examples section found doesn't appear in the "errors found" section (if other errors appear, it's probably fine for now)

You should then also remove the function you've fixed up to the exclusions in ci/code_checks.sh under the EX01 section

Feel free to take a few related functions per PR - I just did a single one to show an example

DeaMariaLeon · 2023-02-10T09:49:16Z

I'll write examples for pandas.Series.shape

lucasrodes added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Nov 15, 2020

lucasrodes changed the title ~~DOC: Fix EX01 in docstrings~~ DOC: Fix EX01 issues in docstrings Nov 15, 2020

lucasrodes mentioned this issue Nov 15, 2020

Specify less errors in validate_docstrings MarcoGorelli/PyDataGlobal2020-sprint#4

Open

lucasrodes mentioned this issue Nov 16, 2020

DOC: Timestamp EX01 errors #37904

Merged

5 tasks

xinrong-meng mentioned this issue Nov 22, 2020

[WIP] DOC: MultiIndex EX01 errors #37993

Merged

5 tasks

TheNeuralBit mentioned this issue Mar 3, 2021

DOC: Add Notes and Examples back to GroupBy.apply docs template #40207

Merged

4 tasks

lithomas1 removed the Needs Triage Issue that has not been reviewed by a pandas team member label Mar 22, 2021

This was referenced Jan 7, 2023

DOC: update docstrings of Interval's attributes #50609

Merged

DOC: improve Index docstrings #50720

Merged

This was referenced Jan 20, 2023

DOC: Fix some RT02 issues in docstrings #50896

Merged

DOC: Ignore functions on validate docstrings - error EX01 #50956

Merged

DeaMariaLeon mentioned this issue Jan 29, 2023

DOC towards complying with EX01 specs #51055

Merged

5 tasks

MarcoGorelli mentioned this issue Jan 31, 2023

DOC add examples to Timestamp.unit #51091

Merged

This was referenced Feb 1, 2023

DOC Unsetting "copy_on_write" mode to remove EX02 errors #51110

Merged

DOC Correcting EX02 errors #51143

Merged

pmeier mentioned this issue Feb 3, 2023

new contributor requesting guidance pmeier/pmeier#7

Closed

MarcoGorelli mentioned this issue Feb 6, 2023

DOC: Fix code style in any and all methods #51195

Closed

5 tasks

This was referenced Feb 6, 2023

DOC Correcting EX02 errors #51198

Merged

DOC Correcting EX02 errors #51217

Merged

DOC Correcting EX02 errors #51231

Merged

DeaMariaLeon mentioned this issue Feb 10, 2023

DOC Fix EX01 errors - added example #51288

Merged

5 tasks

This was referenced Jul 5, 2023

DOC: Fixing EX01 - Added examples #54004

Merged

DOC: Fixing EX01 - Added examples #54039

Merged

DOC: Fixing EX01 - Added examples #54084

Merged

mroeschke closed this as completed in #54384 Aug 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Fix EX01 issues in docstrings #37875

DOC: Fix EX01 issues in docstrings #37875

lucasrodes commented Nov 15, 2020 •

edited by MarcoGorelli

Loading

lucasrodes commented Nov 15, 2020

xinrong-meng commented Nov 22, 2020

xinrong-meng commented Nov 28, 2020

lucasrodes commented Nov 29, 2020

xinrong-meng commented Nov 30, 2020

TheNeuralBit commented Mar 3, 2021

MarcoGorelli commented Jan 31, 2023

DeaMariaLeon commented Feb 10, 2023

DOC: Fix EX01 issues in docstrings #37875

DOC: Fix EX01 issues in docstrings #37875

Comments

lucasrodes commented Nov 15, 2020 • edited by MarcoGorelli Loading

Location of the documentation

Documentation problem

Suggested fix for documentation

Current errors:

lucasrodes commented Nov 15, 2020

xinrong-meng commented Nov 22, 2020

xinrong-meng commented Nov 28, 2020

lucasrodes commented Nov 29, 2020

xinrong-meng commented Nov 30, 2020

TheNeuralBit commented Mar 3, 2021

MarcoGorelli commented Jan 31, 2023

DeaMariaLeon commented Feb 10, 2023

lucasrodes commented Nov 15, 2020 •

edited by MarcoGorelli

Loading