You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To avoid typos and to help contributors, we implemented a validation to make sure docstrings contain the right sections. Before we can add the script to the continuos integration and automatically validate that new changes are correct, we need to fix all current issues.
The main issue at the moment is that the section See Also is in many cases spelled See also (with lower case a).
This is the list of all the cases detected:
./scripts/validate_docstrings.py --errors=GL06
pandas.read_sql_table: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.read_sql_query: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.read_sql: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.melt: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.merge_asof: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.to_numeric: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.to_datetime: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.to_timedelta: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.put: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.astype: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.add: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.sub: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.mul: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.div: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.truediv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.floordiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.mod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.pow: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.radd: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rsub: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rmul: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rdiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rtruediv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rfloordiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rmod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rpow: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.lt: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.gt: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.le: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.ge: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.ne: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.eq: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.agg: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.aggregate: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.all: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cummax: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cummin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cumprod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cumsum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.argsort: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.ravel: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.repeat: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.append: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.dt.to_period: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Categorical.categories: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cat.categories: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.cat.remove_unused_categories: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.empty: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.astype: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.applymap: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.agg: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.aggregate: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.all: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.cummax: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.cummin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.cumprod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.cumsum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.unstack: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.melt: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.append: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DataFrame.from_csv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.astype: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.add: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.sub: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.mul: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.div: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.truediv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.floordiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.mod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.pow: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.radd: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rsub: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rmul: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rdiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rtruediv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rfloordiv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rmod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.rpow: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.cummax: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.cummin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.cumprod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.cumsum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.argmin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.argmax: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.take: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.putmask: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.notna: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.ravel: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.argsort: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.get_level_values: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Index.isin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Int64Index: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.UInt64Index: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Float64Index: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.CategoricalIndex.remove_unused_categories: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.MultiIndex.to_frame: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.MultiIndex.get_loc: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.DatetimeIndex.to_period: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Period.start_time: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Rolling.max: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Rolling.cov: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Rolling.skew: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Rolling.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Rolling.aggregate: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Expanding.max: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Expanding.cov: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Expanding.skew: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Expanding.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.Expanding.aggregate: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.EWM.mean: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.EWM.std: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.EWM.var: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.EWM.corr: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.window.EWM.cov: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.all: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.any: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.count: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.cumcount: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.first: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.head: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.last: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.max: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.mean: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.median: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.min: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.ngroup: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.nth: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.ohlc: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.prod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.rank: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.pct_change: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.size: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.sem: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.std: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.sum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.var: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.GroupBy.tail: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.agg: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.all: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.any: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.cummax: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.cummin: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.cumprod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.cumsum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.pct_change: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.rank: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.resample: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.shift: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.groupby.DataFrameGroupBy.size: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.apply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.aggregate: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.count: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.first: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.last: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.max: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.mean: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.median: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.min: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.ohlc: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.prod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.size: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.sem: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.core.resample.Resampler.sum: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.api.extensions.register_dataframe_accessor: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.api.extensions.register_series_accessor: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.api.extensions.register_index_accessor: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.compress: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.divide: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.divmod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.from_csv: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.multiply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.rdivmod: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Series.subtract: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.all: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.divide: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.empty: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.multiply: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
pandas.Panel.subtract: Found unknown section "See also". Allowed sections are: Parameters, Attributes, Methods, Returns, Yields, Other Parameters, Raises, Warns, See Also, Notes, References, Examples
Probably the best approach would be to fix them automatically with some bash command using sed (or may be search and replace functionality of an IDE). Note that we can't naively replace all occurrences in the code, as there are cases like in Choice of sorting algorithm. See also :func:numpy.sort for more where we don't want to capitalize the a. But probably if we replace only the cases where See also is the only text in the line, that should be all right (and if there is any false positive, we can restore it afterwards).
The text was updated successfully, but these errors were encountered:
To avoid typos and to help contributors, we implemented a validation to make sure docstrings contain the right sections. Before we can add the script to the continuos integration and automatically validate that new changes are correct, we need to fix all current issues.
The main issue at the moment is that the section
See Also
is in many cases spelledSee also
(with lower casea
).This is the list of all the cases detected:
Probably the best approach would be to fix them automatically with some bash command using
sed
(or may be search and replace functionality of an IDE). Note that we can't naively replace all occurrences in the code, as there are cases like inChoice of sorting algorithm. See also :func:
numpy.sortfor more
where we don't want to capitalize thea
. But probably if we replace only the cases whereSee also
is the only text in the line, that should be all right (and if there is any false positive, we can restore it afterwards).The text was updated successfully, but these errors were encountered: