Skip to content

DOC: Fix format of the See Also descriptions #23630

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

Closed
datapythonista opened this issue Nov 11, 2018 · 9 comments · Fixed by #28789
Closed

DOC: Fix format of the See Also descriptions #23630

datapythonista opened this issue Nov 11, 2018 · 9 comments · Fixed by #28789
Labels
CI Continuous Integration Clean Code Style Code style, linting, code_checks Docs good first issue
Milestone

Comments

@datapythonista
Copy link
Member

Our standard for the See Also section is:

See Also
--------
DataFrame.head : Some description.
DataFrame.tail: That starts with a capital letter, and finishes with a period.

In many cases, for historical reasons, the format of the description does not start with a capital and does not finish with a period. We should fix those.

The next command shows all the cases that are wrong and should be fixed. Note that as Panel will be removed soon, is better to not waste time fixing their docstrings (see the grep).

When calling validate_docstrings.py, an argument --format=azure (or --format=json) and the output will contain the name of the file with the source code, and the line, where the function is defined. It won't always be correct, as introspection in Python is not perfect when the code is tricky, but it can be useful in many cases.

$ ./scripts/validate_docstrings.py --errors=SA02,SA03 | grep -v "^pandas.Panel."
pandas.read_hdf: Missing period at end of description for See Also "pandas.DataFrame.to_hdf" reference
pandas.read_hdf: Description should be capitalized for See Also "pandas.DataFrame.to_hdf" reference
pandas.read_hdf: Missing period at end of description for See Also "pandas.HDFStore" reference
pandas.read_hdf: Description should be capitalized for See Also "pandas.HDFStore" reference
pandas.read_stata: Missing period at end of description for See Also "pandas.io.stata.StataReader" reference
pandas.read_stata: Description should be capitalized for See Also "pandas.io.stata.StataReader" reference
pandas.read_stata: Missing period at end of description for See Also "pandas.DataFrame.to_stata" reference
pandas.read_stata: Description should be capitalized for See Also "pandas.DataFrame.to_stata" reference
pandas.pivot: Description should be capitalized for See Also "DataFrame.pivot_table" reference
pandas.pivot: Description should be capitalized for See Also "DataFrame.unstack" reference
pandas.pivot_table: Missing period at end of description for See Also "DataFrame.pivot" reference
pandas.pivot_table: Description should be capitalized for See Also "DataFrame.pivot" reference
pandas.merge: Description should be capitalized for See Also "merge_ordered" reference
pandas.merge: Description should be capitalized for See Also "merge_asof" reference
pandas.merge: Description should be capitalized for See Also "DataFrame.join" reference
pandas.isna: Description should be capitalized for See Also "notna" reference
pandas.isnull: Description should be capitalized for See Also "notna" reference
pandas.notna: Description should be capitalized for See Also "isna" reference
pandas.notnull: Description should be capitalized for See Also "isna" reference
pandas.interval_range: Description should be capitalized for See Also "IntervalIndex" reference
pandas.Series.at: Missing period at end of description for See Also "DataFrame.iat" reference
pandas.Series.at: Missing period at end of description for See Also "DataFrame.loc" reference
pandas.Series.at: Missing period at end of description for See Also "Series.at" reference
pandas.Series.iat: Missing period at end of description for See Also "DataFrame.at" reference
pandas.Series.iat: Missing period at end of description for See Also "DataFrame.loc" reference
pandas.Series.iat: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.Series.loc: Missing period at end of description for See Also "DataFrame.at" reference
pandas.Series.loc: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.Series.loc: Missing period at end of description for See Also "Series.loc" reference
pandas.Series.combine: Missing period at end of description for See Also "Series.combine_first" reference
pandas.Series.combine_first: Missing period at end of description for See Also "Series.combine" reference
pandas.Series.apply: Missing period at end of description for See Also "Series.map" reference
pandas.Series.apply: Missing period at end of description for See Also "Series.agg" reference
pandas.Series.apply: Description should be capitalized for See Also "Series.agg" reference
pandas.Series.apply: Missing period at end of description for See Also "Series.transform" reference
pandas.Series.apply: Description should be capitalized for See Also "Series.transform" reference
pandas.Series.rolling: Missing period at end of description for See Also "ewm" reference
pandas.Series.expanding: Missing period at end of description for See Also "rolling" reference
pandas.Series.expanding: Missing period at end of description for See Also "ewm" reference
pandas.Series.ewm: Missing period at end of description for See Also "rolling" reference
pandas.Series.abs: Description should be capitalized for See Also "numpy.absolute" reference
pandas.Series.all: Missing period at end of description for See Also "pandas.Series.all" reference
pandas.Series.all: Missing period at end of description for See Also "pandas.DataFrame.any" reference
pandas.Series.between: Missing period at end of description for See Also "pandas.Series.gt" reference
pandas.Series.between: Missing period at end of description for See Also "pandas.Series.lt" reference
pandas.Series.clip_lower: Missing period at end of description for See Also "DataFrame.clip" reference
pandas.Series.clip_lower: Missing period at end of description for See Also "DataFrame.clip_upper" reference
pandas.Series.clip_lower: Missing period at end of description for See Also "Series.clip" reference
pandas.Series.clip_lower: Missing period at end of description for See Also "Series.clip_upper" reference
pandas.Series.clip_upper: Missing period at end of description for See Also "DataFrame.clip" reference
pandas.Series.clip_upper: Missing period at end of description for See Also "DataFrame.clip_lower" reference
pandas.Series.clip_upper: Missing period at end of description for See Also "Series.clip" reference
pandas.Series.clip_upper: Missing period at end of description for See Also "Series.clip_lower" reference
pandas.Series.diff: Missing period at end of description for See Also "DataFrame.diff" reference
pandas.Series.unique: Description should be capitalized for See Also "pandas.unique" reference
pandas.Series.unique: Description should be capitalized for See Also "Index.unique" reference
pandas.Series.value_counts: Missing period at end of description for See Also "Series.count" reference
pandas.Series.value_counts: Description should be capitalized for See Also "Series.count" reference
pandas.Series.value_counts: Missing period at end of description for See Also "DataFrame.count" reference
pandas.Series.value_counts: Description should be capitalized for See Also "DataFrame.count" reference
pandas.Series.drop_duplicates: Missing period at end of description for See Also "Index.drop_duplicates" reference
pandas.Series.drop_duplicates: Description should be capitalized for See Also "Index.drop_duplicates" reference
pandas.Series.drop_duplicates: Missing period at end of description for See Also "DataFrame.drop_duplicates" reference
pandas.Series.drop_duplicates: Description should be capitalized for See Also "DataFrame.drop_duplicates" reference
pandas.Series.drop_duplicates: Description should be capitalized for See Also "Series.duplicated" reference
pandas.Series.duplicated: Missing period at end of description for See Also "pandas.Index.duplicated" reference
pandas.Series.duplicated: Missing period at end of description for See Also "pandas.DataFrame.duplicated" reference
pandas.Series.duplicated: Missing period at end of description for See Also "pandas.Series.drop_duplicates" reference
pandas.Series.first: Missing period at end of description for See Also "last" reference
pandas.Series.first: Missing period at end of description for See Also "at_time" reference
pandas.Series.first: Missing period at end of description for See Also "between_time" reference
pandas.Series.isin: Missing period at end of description for See Also "pandas.DataFrame.isin" reference
pandas.Series.isin: Description should be capitalized for See Also "pandas.DataFrame.isin" reference
pandas.Series.last: Missing period at end of description for See Also "first" reference
pandas.Series.last: Missing period at end of description for See Also "at_time" reference
pandas.Series.last: Missing period at end of description for See Also "between_time" reference
pandas.Series.rename_axis: Missing period at end of description for See Also "pandas.Series.rename" reference
pandas.Series.rename_axis: Missing period at end of description for See Also "pandas.DataFrame.rename" reference
pandas.Series.rename_axis: Missing period at end of description for See Also "pandas.Index.rename" reference
pandas.Series.where: Missing period at end of description for See Also "DataFrame.mask" reference
pandas.Series.mask: Missing period at end of description for See Also "DataFrame.where" reference
pandas.Series.isna: Missing period at end of description for See Also "Series.isnull" reference
pandas.Series.isna: Description should be capitalized for See Also "Series.isnull" reference
pandas.Series.isna: Missing period at end of description for See Also "Series.notna" reference
pandas.Series.isna: Description should be capitalized for See Also "Series.notna" reference
pandas.Series.isna: Missing period at end of description for See Also "Series.dropna" reference
pandas.Series.isna: Description should be capitalized for See Also "Series.dropna" reference
pandas.Series.isna: Missing period at end of description for See Also "isna" reference
pandas.Series.isna: Description should be capitalized for See Also "isna" reference
pandas.Series.notna: Missing period at end of description for See Also "Series.notnull" reference
pandas.Series.notna: Description should be capitalized for See Also "Series.notnull" reference
pandas.Series.notna: Missing period at end of description for See Also "Series.isna" reference
pandas.Series.notna: Description should be capitalized for See Also "Series.isna" reference
pandas.Series.notna: Missing period at end of description for See Also "Series.dropna" reference
pandas.Series.notna: Description should be capitalized for See Also "Series.dropna" reference
pandas.Series.notna: Missing period at end of description for See Also "notna" reference
pandas.Series.notna: Description should be capitalized for See Also "notna" reference
pandas.Series.sort_index: Missing period at end of description for See Also "DataFrame.sort_index" reference
pandas.Series.sort_index: Missing period at end of description for See Also "DataFrame.sort_values" reference
pandas.Series.sort_index: Missing period at end of description for See Also "Series.sort_values" reference
pandas.Series.squeeze: Missing period at end of description for See Also "Series.iloc" reference
pandas.Series.squeeze: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.Series.append: Missing period at end of description for See Also "pandas.concat" reference
pandas.Series.replace: Missing period at end of description for See Also "Series.fillna" reference
pandas.Series.replace: Missing period at end of description for See Also "Series.where" reference
pandas.Series.at_time: Missing period at end of description for See Also "between_time" reference
pandas.Series.at_time: Missing period at end of description for See Also "first" reference
pandas.Series.at_time: Missing period at end of description for See Also "last" reference
pandas.Series.at_time: Missing period at end of description for See Also "DatetimeIndex.indexer_at_time" reference
pandas.Series.between_time: Missing period at end of description for See Also "at_time" reference
pandas.Series.between_time: Missing period at end of description for See Also "first" reference
pandas.Series.between_time: Missing period at end of description for See Also "last" reference
pandas.Series.between_time: Missing period at end of description for See Also "DatetimeIndex.indexer_between_time" reference
pandas.Series.dt.to_period: Missing period at end of description for See Also "pandas.PeriodIndex" reference
pandas.Series.dt.to_period: Missing period at end of description for See Also "pandas.DatetimeIndex.to_pydatetime" reference
pandas.Series.dt.tz_convert: Missing period at end of description for See Also "DatetimeIndex.tz" reference
pandas.Series.dt.strftime: Missing period at end of description for See Also "pandas.to_datetime" reference
pandas.Series.str.cat: Missing period at end of description for See Also "split" reference
pandas.Series.str.cat: Missing period at end of description for See Also "join" reference
pandas.Series.str.contains: Missing period at end of description for See Also "match" reference
pandas.Series.str.contains: Description should be capitalized for See Also "match" reference
pandas.Series.str.extract: Missing period at end of description for See Also "extractall" reference
pandas.Series.str.extract: Description should be capitalized for See Also "extractall" reference
pandas.Series.str.extractall: Missing period at end of description for See Also "extract" reference
pandas.Series.str.extractall: Description should be capitalized for See Also "extract" reference
pandas.Series.str.find: Missing period at end of description for See Also "rfind" reference
pandas.Series.str.index: Missing period at end of description for See Also "rindex" reference
pandas.Series.str.lstrip: Missing period at end of description for See Also "Series.str.strip" reference
pandas.Series.str.lstrip: Missing period at end of description for See Also "Series.str.lstrip" reference
pandas.Series.str.lstrip: Missing period at end of description for See Also "Series.str.rstrip" reference
pandas.Series.str.match: Missing period at end of description for See Also "contains" reference
pandas.Series.str.match: Description should be capitalized for See Also "contains" reference
pandas.Series.str.match: Missing period at end of description for See Also "extract" reference
pandas.Series.str.match: Description should be capitalized for See Also "extract" reference
pandas.Series.str.partition: Missing period at end of description for See Also "rpartition" reference
pandas.Series.str.rfind: Missing period at end of description for See Also "find" reference
pandas.Series.str.rindex: Missing period at end of description for See Also "index" reference
pandas.Series.str.rpartition: Missing period at end of description for See Also "partition" reference
pandas.Series.str.rstrip: Missing period at end of description for See Also "Series.str.strip" reference
pandas.Series.str.rstrip: Missing period at end of description for See Also "Series.str.lstrip" reference
pandas.Series.str.rstrip: Missing period at end of description for See Also "Series.str.rstrip" reference
pandas.Series.str.strip: Missing period at end of description for See Also "Series.str.strip" reference
pandas.Series.str.strip: Missing period at end of description for See Also "Series.str.lstrip" reference
pandas.Series.str.strip: Missing period at end of description for See Also "Series.str.rstrip" reference
pandas.Categorical: Missing period at end of description for See Also "pandas.api.types.CategoricalDtype" reference
pandas.Categorical: Missing period at end of description for See Also "CategoricalIndex" reference
pandas.Series.to_sql: Missing period at end of description for See Also "pandas.read_sql" reference
pandas.Series.to_sql: Description should be capitalized for See Also "pandas.read_sql" reference
pandas.DataFrame: Missing period at end of description for See Also "DataFrame.from_records" reference
pandas.DataFrame: Description should be capitalized for See Also "DataFrame.from_records" reference
pandas.DataFrame: Missing period at end of description for See Also "DataFrame.from_dict" reference
pandas.DataFrame: Description should be capitalized for See Also "DataFrame.from_dict" reference
pandas.DataFrame: Missing period at end of description for See Also "DataFrame.from_items" reference
pandas.DataFrame: Description should be capitalized for See Also "DataFrame.from_items" reference
pandas.DataFrame.dtypes: Description should be capitalized for See Also "pandas.DataFrame.ftypes" reference
pandas.DataFrame.values: Missing period at end of description for See Also "pandas.DataFrame.index" reference
pandas.DataFrame.values: Missing period at end of description for See Also "pandas.DataFrame.columns" reference
pandas.DataFrame.isna: Missing period at end of description for See Also "DataFrame.isnull" reference
pandas.DataFrame.isna: Description should be capitalized for See Also "DataFrame.isnull" reference
pandas.DataFrame.isna: Missing period at end of description for See Also "DataFrame.notna" reference
pandas.DataFrame.isna: Description should be capitalized for See Also "DataFrame.notna" reference
pandas.DataFrame.isna: Missing period at end of description for See Also "DataFrame.dropna" reference
pandas.DataFrame.isna: Description should be capitalized for See Also "DataFrame.dropna" reference
pandas.DataFrame.isna: Missing period at end of description for See Also "isna" reference
pandas.DataFrame.isna: Description should be capitalized for See Also "isna" reference
pandas.DataFrame.notna: Missing period at end of description for See Also "DataFrame.notnull" reference
pandas.DataFrame.notna: Description should be capitalized for See Also "DataFrame.notnull" reference
pandas.DataFrame.notna: Missing period at end of description for See Also "DataFrame.isna" reference
pandas.DataFrame.notna: Description should be capitalized for See Also "DataFrame.isna" reference
pandas.DataFrame.notna: Missing period at end of description for See Also "DataFrame.dropna" reference
pandas.DataFrame.notna: Description should be capitalized for See Also "DataFrame.dropna" reference
pandas.DataFrame.notna: Missing period at end of description for See Also "notna" reference
pandas.DataFrame.notna: Description should be capitalized for See Also "notna" reference
pandas.DataFrame.at: Missing period at end of description for See Also "DataFrame.iat" reference
pandas.DataFrame.at: Missing period at end of description for See Also "DataFrame.loc" reference
pandas.DataFrame.at: Missing period at end of description for See Also "Series.at" reference
pandas.DataFrame.iat: Missing period at end of description for See Also "DataFrame.at" reference
pandas.DataFrame.iat: Missing period at end of description for See Also "DataFrame.loc" reference
pandas.DataFrame.iat: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.DataFrame.loc: Missing period at end of description for See Also "DataFrame.at" reference
pandas.DataFrame.loc: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.DataFrame.loc: Missing period at end of description for See Also "Series.loc" reference
pandas.DataFrame.where: Missing period at end of description for See Also "DataFrame.mask" reference
pandas.DataFrame.mask: Missing period at end of description for See Also "DataFrame.where" reference
pandas.DataFrame.combine: Missing period at end of description for See Also "DataFrame.combine_first" reference
pandas.DataFrame.combine_first: Missing period at end of description for See Also "DataFrame.combine" reference
pandas.DataFrame.apply: Missing period at end of description for See Also "DataFrame.applymap" reference
pandas.DataFrame.apply: Missing period at end of description for See Also "DataFrame.aggregate" reference
pandas.DataFrame.apply: Description should be capitalized for See Also "DataFrame.aggregate" reference
pandas.DataFrame.apply: Missing period at end of description for See Also "DataFrame.transform" reference
pandas.DataFrame.apply: Description should be capitalized for See Also "DataFrame.transform" reference
pandas.DataFrame.applymap: Missing period at end of description for See Also "DataFrame.apply" reference
pandas.DataFrame.rolling: Missing period at end of description for See Also "ewm" reference
pandas.DataFrame.expanding: Missing period at end of description for See Also "rolling" reference
pandas.DataFrame.expanding: Missing period at end of description for See Also "ewm" reference
pandas.DataFrame.ewm: Missing period at end of description for See Also "rolling" reference
pandas.DataFrame.abs: Description should be capitalized for See Also "numpy.absolute" reference
pandas.DataFrame.all: Missing period at end of description for See Also "pandas.Series.all" reference
pandas.DataFrame.all: Missing period at end of description for See Also "pandas.DataFrame.any" reference
pandas.DataFrame.clip_lower: Missing period at end of description for See Also "DataFrame.clip" reference
pandas.DataFrame.clip_lower: Missing period at end of description for See Also "DataFrame.clip_upper" reference
pandas.DataFrame.clip_lower: Missing period at end of description for See Also "Series.clip" reference
pandas.DataFrame.clip_lower: Missing period at end of description for See Also "Series.clip_upper" reference
pandas.DataFrame.clip_upper: Missing period at end of description for See Also "DataFrame.clip" reference
pandas.DataFrame.clip_upper: Missing period at end of description for See Also "DataFrame.clip_lower" reference
pandas.DataFrame.clip_upper: Missing period at end of description for See Also "Series.clip" reference
pandas.DataFrame.clip_upper: Missing period at end of description for See Also "Series.clip_lower" reference
pandas.DataFrame.count: Missing period at end of description for See Also "Series.count" reference
pandas.DataFrame.count: Description should be capitalized for See Also "Series.count" reference
pandas.DataFrame.count: Missing period at end of description for See Also "DataFrame.shape" reference
pandas.DataFrame.count: Description should be capitalized for See Also "DataFrame.shape" reference
pandas.DataFrame.count: Missing period at end of description for See Also "DataFrame.isna" reference
pandas.DataFrame.count: Description should be capitalized for See Also "DataFrame.isna" reference
pandas.DataFrame.cov: Missing period at end of description for See Also "pandas.Series.cov" reference
pandas.DataFrame.cov: Description should be capitalized for See Also "pandas.Series.cov" reference
pandas.DataFrame.cov: Missing period at end of description for See Also "pandas.core.window.EWM.cov" reference
pandas.DataFrame.cov: Description should be capitalized for See Also "pandas.core.window.EWM.cov" reference
pandas.DataFrame.cov: Missing period at end of description for See Also "pandas.core.window.Expanding.cov" reference
pandas.DataFrame.cov: Description should be capitalized for See Also "pandas.core.window.Expanding.cov" reference
pandas.DataFrame.cov: Missing period at end of description for See Also "pandas.core.window.Rolling.cov" reference
pandas.DataFrame.cov: Description should be capitalized for See Also "pandas.core.window.Rolling.cov" reference
pandas.DataFrame.at_time: Missing period at end of description for See Also "between_time" reference
pandas.DataFrame.at_time: Missing period at end of description for See Also "first" reference
pandas.DataFrame.at_time: Missing period at end of description for See Also "last" reference
pandas.DataFrame.at_time: Missing period at end of description for See Also "DatetimeIndex.indexer_at_time" reference
pandas.DataFrame.between_time: Missing period at end of description for See Also "at_time" reference
pandas.DataFrame.between_time: Missing period at end of description for See Also "first" reference
pandas.DataFrame.between_time: Missing period at end of description for See Also "last" reference
pandas.DataFrame.between_time: Missing period at end of description for See Also "DatetimeIndex.indexer_between_time" reference
pandas.DataFrame.drop: Missing period at end of description for See Also "DataFrame.dropna" reference
pandas.DataFrame.drop: Missing period at end of description for See Also "DataFrame.drop_duplicates" reference
pandas.DataFrame.first: Missing period at end of description for See Also "last" reference
pandas.DataFrame.first: Missing period at end of description for See Also "at_time" reference
pandas.DataFrame.first: Missing period at end of description for See Also "between_time" reference
pandas.DataFrame.last: Missing period at end of description for See Also "first" reference
pandas.DataFrame.last: Missing period at end of description for See Also "at_time" reference
pandas.DataFrame.last: Missing period at end of description for See Also "between_time" reference
pandas.DataFrame.rename_axis: Missing period at end of description for See Also "pandas.Series.rename" reference
pandas.DataFrame.rename_axis: Missing period at end of description for See Also "pandas.DataFrame.rename" reference
pandas.DataFrame.rename_axis: Missing period at end of description for See Also "pandas.Index.rename" reference
pandas.DataFrame.replace: Missing period at end of description for See Also "DataFrame.fillna" reference
pandas.DataFrame.replace: Missing period at end of description for See Also "DataFrame.where" reference
pandas.DataFrame.pivot: Description should be capitalized for See Also "DataFrame.pivot_table" reference
pandas.DataFrame.pivot: Description should be capitalized for See Also "DataFrame.unstack" reference
pandas.DataFrame.pivot_table: Missing period at end of description for See Also "DataFrame.pivot" reference
pandas.DataFrame.pivot_table: Description should be capitalized for See Also "DataFrame.pivot" reference
pandas.DataFrame.nlargest: Missing period at end of description for See Also "DataFrame.sort_values" reference
pandas.DataFrame.squeeze: Missing period at end of description for See Also "Series.iloc" reference
pandas.DataFrame.squeeze: Missing period at end of description for See Also "DataFrame.iloc" reference
pandas.DataFrame.append: Missing period at end of description for See Also "pandas.concat" reference
pandas.DataFrame.merge: Description should be capitalized for See Also "merge_ordered" reference
pandas.DataFrame.merge: Description should be capitalized for See Also "merge_asof" reference
pandas.DataFrame.merge: Description should be capitalized for See Also "DataFrame.join" reference
pandas.DataFrame.plot.hexbin: Description should be capitalized for See Also "matplotlib.pyplot.hexbin" reference
pandas.DataFrame.plot.scatter: Description should be capitalized for See Also "matplotlib.pyplot.scatter" reference
pandas.DataFrame.from_dict: Missing period at end of description for See Also "DataFrame.from_records" reference
pandas.DataFrame.from_dict: Missing period at end of description for See Also "DataFrame" reference
pandas.DataFrame.to_sql: Missing period at end of description for See Also "pandas.read_sql" reference
pandas.DataFrame.to_sql: Description should be capitalized for See Also "pandas.read_sql" reference
pandas.DataFrame.to_stata: Missing period at end of description for See Also "pandas.read_stata" reference
pandas.DataFrame.to_stata: Missing period at end of description for See Also "pandas.io.stata.StataWriter" reference
pandas.DataFrame.to_stata: Description should be capitalized for See Also "pandas.io.stata.StataWriter" reference
pandas.DataFrame.to_stata: Missing period at end of description for See Also "pandas.io.stata.StataWriter117" reference
pandas.DataFrame.to_stata: Description should be capitalized for See Also "pandas.io.stata.StataWriter117" reference
pandas.DataFrame.to_records: Description should be capitalized for See Also "DataFrame.from_records" reference
pandas.DataFrame.to_records: Description should be capitalized for See Also "numpy.recarray" reference
pandas.Index: Missing period at end of description for See Also "RangeIndex" reference
pandas.Index: Missing period at end of description for See Also "MultiIndex" reference
pandas.Index: Description should be capitalized for See Also "IntervalIndex" reference
pandas.Index.drop_duplicates: Missing period at end of description for See Also "Series.drop_duplicates" reference
pandas.Index.drop_duplicates: Description should be capitalized for See Also "Series.drop_duplicates" reference
pandas.Index.drop_duplicates: Missing period at end of description for See Also "DataFrame.drop_duplicates" reference
pandas.Index.drop_duplicates: Description should be capitalized for See Also "DataFrame.drop_duplicates" reference
pandas.Index.drop_duplicates: Description should be capitalized for See Also "Index.duplicated" reference
pandas.Index.duplicated: Missing period at end of description for See Also "pandas.Series.duplicated" reference
pandas.Index.duplicated: Missing period at end of description for See Also "pandas.DataFrame.duplicated" reference
pandas.Index.duplicated: Missing period at end of description for See Also "pandas.Index.drop_duplicates" reference
pandas.Index.repeat: Missing period at end of description for See Also "Series.repeat" reference
pandas.Index.repeat: Missing period at end of description for See Also "numpy.repeat" reference
pandas.Index.value_counts: Missing period at end of description for See Also "Series.count" reference
pandas.Index.value_counts: Description should be capitalized for See Also "Series.count" reference
pandas.Index.value_counts: Missing period at end of description for See Also "DataFrame.count" reference
pandas.Index.value_counts: Description should be capitalized for See Also "DataFrame.count" reference
pandas.Index.isna: Description should be capitalized for See Also "pandas.Index.notna" reference
pandas.Index.isna: Description should be capitalized for See Also "pandas.Index.dropna" reference
pandas.Index.isna: Description should be capitalized for See Also "pandas.isna" reference
pandas.Index.isna: Description should be capitalized for See Also "Series.isna" reference
pandas.Index.notna: Missing period at end of description for See Also "Index.notnull" reference
pandas.Index.notna: Description should be capitalized for See Also "Index.notnull" reference
pandas.Index.notna: Missing period at end of description for See Also "Index.isna" reference
pandas.Index.notna: Description should be capitalized for See Also "Index.isna" reference
pandas.Index.notna: Missing period at end of description for See Also "pandas.notna" reference
pandas.Index.notna: Description should be capitalized for See Also "pandas.notna" reference
pandas.Index.asof: Description should be capitalized for See Also "Index.get_loc" reference
pandas.Index.get_level_values: Missing period at end of description for See Also "MultiIndex.get_level_values" reference
pandas.Index.get_level_values: Description should be capitalized for See Also "MultiIndex.get_level_values" reference
pandas.Index.slice_locs: Missing period at end of description for See Also "Index.get_loc" reference
pandas.RangeIndex: Missing period at end of description for See Also "Index" reference
pandas.RangeIndex: Missing period at end of description for See Also "Int64Index" reference
pandas.Int64Index: Missing period at end of description for See Also "Index" reference
pandas.UInt64Index: Missing period at end of description for See Also "Index" reference
pandas.Float64Index: Missing period at end of description for See Also "Index" reference
pandas.IntervalIndex: Missing period at end of description for See Also "Index" reference
pandas.IntervalIndex: Missing period at end of description for See Also "Interval" reference
pandas.IntervalIndex: Missing period at end of description for See Also "interval_range" reference
pandas.IntervalIndex: Missing period at end of description for See Also "cut" reference
pandas.IntervalIndex: Missing period at end of description for See Also "qcut" reference
pandas.IntervalIndex.from_tuples: Missing period at end of description for See Also "interval_range" reference
pandas.IntervalIndex.from_tuples: Missing period at end of description for See Also "IntervalIndex.from_arrays" reference
pandas.IntervalIndex.from_tuples: Missing period at end of description for See Also "IntervalIndex.from_breaks" reference
pandas.IntervalIndex.from_breaks: Missing period at end of description for See Also "interval_range" reference
pandas.IntervalIndex.from_breaks: Missing period at end of description for See Also "IntervalIndex.from_arrays" reference
pandas.IntervalIndex.from_breaks: Missing period at end of description for See Also "IntervalIndex.from_tuples" reference
pandas.MultiIndex: Missing period at end of description for See Also "MultiIndex.from_arrays" reference
pandas.MultiIndex: Missing period at end of description for See Also "MultiIndex.from_product" reference
pandas.MultiIndex: Missing period at end of description for See Also "MultiIndex.from_tuples" reference
pandas.MultiIndex: Missing period at end of description for See Also "Index" reference
pandas.MultiIndex.from_arrays: Missing period at end of description for See Also "MultiIndex.from_tuples" reference
pandas.MultiIndex.from_arrays: Missing period at end of description for See Also "MultiIndex.from_product" reference
pandas.MultiIndex.from_tuples: Missing period at end of description for See Also "MultiIndex.from_arrays" reference
pandas.MultiIndex.from_tuples: Missing period at end of description for See Also "MultiIndex.from_product" reference
pandas.MultiIndex.from_product: Missing period at end of description for See Also "MultiIndex.from_arrays" reference
pandas.MultiIndex.from_product: Missing period at end of description for See Also "MultiIndex.from_tuples" reference
pandas.MultiIndex.swaplevel: Missing period at end of description for See Also "Series.swaplevel" reference
pandas.MultiIndex.swaplevel: Missing period at end of description for See Also "Dataframe.swaplevel" reference
pandas.MultiIndex.get_loc: Description should be capitalized for See Also "Index.get_loc" reference
pandas.DatetimeIndex: Missing period at end of description for See Also "Index" reference
pandas.DatetimeIndex: Missing period at end of description for See Also "TimedeltaIndex" reference
pandas.DatetimeIndex: Missing period at end of description for See Also "PeriodIndex" reference
pandas.DatetimeIndex: Missing period at end of description for See Also "pandas.to_datetime" reference
pandas.DatetimeIndex.strftime: Missing period at end of description for See Also "pandas.to_datetime" reference
pandas.DatetimeIndex.tz_convert: Missing period at end of description for See Also "DatetimeIndex.tz" reference
pandas.DatetimeIndex.to_period: Missing period at end of description for See Also "pandas.PeriodIndex" reference
pandas.DatetimeIndex.to_period: Missing period at end of description for See Also "pandas.DatetimeIndex.to_pydatetime" reference
pandas.TimedeltaIndex: Missing period at end of description for See Also "Index" reference
pandas.TimedeltaIndex: Missing period at end of description for See Also "DatetimeIndex" reference
pandas.TimedeltaIndex: Missing period at end of description for See Also "PeriodIndex" reference
pandas.PeriodIndex: Missing period at end of description for See Also "Index" reference
pandas.PeriodIndex: Missing period at end of description for See Also "Period" reference
pandas.PeriodIndex: Missing period at end of description for See Also "DatetimeIndex" reference
pandas.PeriodIndex: Missing period at end of description for See Also "TimedeltaIndex" reference
pandas.Period.day: Missing period at end of description for See Also "Period.dayofweek" reference
pandas.Period.day: Missing period at end of description for See Also "Period.dayofyear" reference
pandas.Period.daysinmonth: Missing period at end of description for See Also "Period.days_in_month" reference
pandas.Period.daysinmonth: Missing period at end of description for See Also "Period.dayofyear" reference
pandas.Interval.overlaps: Missing period at end of description for See Also "IntervalArray.overlaps" reference
pandas.Interval.overlaps: Missing period at end of description for See Also "IntervalIndex.overlaps" reference
pandas.core.window.Rolling.count: Missing period at end of description for See Also "pandas.Series.rolling" reference
pandas.core.window.Rolling.count: Missing period at end of description for See Also "pandas.DataFrame.rolling" reference
pandas.core.window.Rolling.count: Missing period at end of description for See Also "pandas.DataFrame.count" reference
pandas.core.window.Rolling.mean: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.mean: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.mean: Missing period at end of description for See Also "Series.mean" reference
pandas.core.window.Rolling.mean: Missing period at end of description for See Also "DataFrame.mean" reference
pandas.core.window.Rolling.median: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.median: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.median: Missing period at end of description for See Also "Series.median" reference
pandas.core.window.Rolling.median: Missing period at end of description for See Also "DataFrame.median" reference
pandas.core.window.Rolling.var: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.var: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.var: Missing period at end of description for See Also "Series.var" reference
pandas.core.window.Rolling.var: Missing period at end of description for See Also "DataFrame.var" reference
pandas.core.window.Rolling.var: Missing period at end of description for See Also "numpy.var" reference
pandas.core.window.Rolling.std: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.std: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.std: Missing period at end of description for See Also "Series.std" reference
pandas.core.window.Rolling.std: Missing period at end of description for See Also "DataFrame.std" reference
pandas.core.window.Rolling.std: Missing period at end of description for See Also "numpy.std" reference
pandas.core.window.Rolling.min: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.min: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.min: Missing period at end of description for See Also "Series.min" reference
pandas.core.window.Rolling.min: Missing period at end of description for See Also "DataFrame.min" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "Series.corr" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "DataFrame.corr" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "rolling.cov" reference
pandas.core.window.Rolling.corr: Missing period at end of description for See Also "numpy.corrcoef" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "Series.rolling" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "DataFrame.rolling" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "Series.kurt" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "DataFrame.kurt" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "scipy.stats.skew" reference
pandas.core.window.Rolling.kurt: Missing period at end of description for See Also "scipy.stats.kurtosis" reference
pandas.core.window.Window.mean: Missing period at end of description for See Also "Series.window" reference
pandas.core.window.Window.mean: Missing period at end of description for See Also "DataFrame.window" reference
pandas.core.window.Window.mean: Missing period at end of description for See Also "Series.mean" reference
pandas.core.window.Window.mean: Missing period at end of description for See Also "DataFrame.mean" reference
pandas.core.window.Expanding.count: Missing period at end of description for See Also "pandas.Series.expanding" reference
pandas.core.window.Expanding.count: Missing period at end of description for See Also "pandas.DataFrame.expanding" reference
pandas.core.window.Expanding.count: Missing period at end of description for See Also "pandas.DataFrame.count" reference
pandas.core.window.Expanding.mean: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.mean: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.mean: Missing period at end of description for See Also "Series.mean" reference
pandas.core.window.Expanding.mean: Missing period at end of description for See Also "DataFrame.mean" reference
pandas.core.window.Expanding.median: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.median: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.median: Missing period at end of description for See Also "Series.median" reference
pandas.core.window.Expanding.median: Missing period at end of description for See Also "DataFrame.median" reference
pandas.core.window.Expanding.var: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.var: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.var: Missing period at end of description for See Also "Series.var" reference
pandas.core.window.Expanding.var: Missing period at end of description for See Also "DataFrame.var" reference
pandas.core.window.Expanding.var: Missing period at end of description for See Also "numpy.var" reference
pandas.core.window.Expanding.std: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.std: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.std: Missing period at end of description for See Also "Series.std" reference
pandas.core.window.Expanding.std: Missing period at end of description for See Also "DataFrame.std" reference
pandas.core.window.Expanding.std: Missing period at end of description for See Also "numpy.std" reference
pandas.core.window.Expanding.min: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.min: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.min: Missing period at end of description for See Also "Series.min" reference
pandas.core.window.Expanding.min: Missing period at end of description for See Also "DataFrame.min" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "Series.corr" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "DataFrame.corr" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "expanding.cov" reference
pandas.core.window.Expanding.corr: Missing period at end of description for See Also "numpy.corrcoef" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "Series.expanding" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "DataFrame.expanding" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "Series.kurt" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "DataFrame.kurt" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "scipy.stats.skew" reference
pandas.core.window.Expanding.kurt: Missing period at end of description for See Also "scipy.stats.kurtosis" reference
pandas.core.groupby.GroupBy.pipe: Missing period at end of description for See Also "pandas.Series.pipe" reference
pandas.core.groupby.GroupBy.pipe: Missing period at end of description for See Also "pandas.DataFrame.pipe" reference
pandas.core.groupby.DataFrameGroupBy.cov: Missing period at end of description for See Also "pandas.Series.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Description should be capitalized for See Also "pandas.Series.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Missing period at end of description for See Also "pandas.core.window.EWM.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Description should be capitalized for See Also "pandas.core.window.EWM.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Missing period at end of description for See Also "pandas.core.window.Expanding.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Description should be capitalized for See Also "pandas.core.window.Expanding.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Missing period at end of description for See Also "pandas.core.window.Rolling.cov" reference
pandas.core.groupby.DataFrameGroupBy.cov: Description should be capitalized for See Also "pandas.core.window.Rolling.cov" reference
pandas.core.groupby.SeriesGroupBy.unique: Description should be capitalized for See Also "pandas.unique" reference
pandas.core.groupby.SeriesGroupBy.unique: Description should be capitalized for See Also "Index.unique" reference
pandas.core.resample.Resampler.pipe: Missing period at end of description for See Also "pandas.Series.pipe" reference
pandas.core.resample.Resampler.pipe: Missing period at end of description for See Also "pandas.DataFrame.pipe" reference
pandas.plotting.radviz: Missing period at end of description for See Also "pandas.plotting.andrews_curves" reference
pandas.api.types.is_number: Missing period at end of description for See Also "pandas.api.types.is_integer" reference
pandas.api.types.is_number: Description should be capitalized for See Also "pandas.api.types.is_integer" reference
pandas.Series.isnull: Missing period at end of description for See Also "Series.isnull" reference
pandas.Series.isnull: Description should be capitalized for See Also "Series.isnull" reference
pandas.Series.isnull: Missing period at end of description for See Also "Series.notna" reference
pandas.Series.isnull: Description should be capitalized for See Also "Series.notna" reference
pandas.Series.isnull: Missing period at end of description for See Also "Series.dropna" reference
pandas.Series.isnull: Description should be capitalized for See Also "Series.dropna" reference
pandas.Series.isnull: Missing period at end of description for See Also "isna" reference
pandas.Series.isnull: Description should be capitalized for See Also "isna" reference
pandas.Series.notnull: Missing period at end of description for See Also "Series.notnull" reference
pandas.Series.notnull: Description should be capitalized for See Also "Series.notnull" reference
pandas.Series.notnull: Missing period at end of description for See Also "Series.isna" reference
pandas.Series.notnull: Description should be capitalized for See Also "Series.isna" reference
pandas.Series.notnull: Missing period at end of description for See Also "Series.dropna" reference
pandas.Series.notnull: Description should be capitalized for See Also "Series.dropna" reference
pandas.Series.notnull: Missing period at end of description for See Also "notna" reference
pandas.Series.notnull: Description should be capitalized for See Also "notna" reference
pandas.DataFrame.isnull: Missing period at end of description for See Also "DataFrame.isnull" reference
pandas.DataFrame.isnull: Description should be capitalized for See Also "DataFrame.isnull" reference
pandas.DataFrame.isnull: Missing period at end of description for See Also "DataFrame.notna" reference
pandas.DataFrame.isnull: Description should be capitalized for See Also "DataFrame.notna" reference
pandas.DataFrame.isnull: Missing period at end of description for See Also "DataFrame.dropna" reference
pandas.DataFrame.isnull: Description should be capitalized for See Also "DataFrame.dropna" reference
pandas.DataFrame.isnull: Missing period at end of description for See Also "isna" reference
pandas.DataFrame.isnull: Description should be capitalized for See Also "isna" reference
pandas.DataFrame.notnull: Missing period at end of description for See Also "DataFrame.notnull" reference
pandas.DataFrame.notnull: Description should be capitalized for See Also "DataFrame.notnull" reference
pandas.DataFrame.notnull: Missing period at end of description for See Also "DataFrame.isna" reference
pandas.DataFrame.notnull: Description should be capitalized for See Also "DataFrame.isna" reference
pandas.DataFrame.notnull: Missing period at end of description for See Also "DataFrame.dropna" reference
pandas.DataFrame.notnull: Description should be capitalized for See Also "DataFrame.dropna" reference
pandas.DataFrame.notnull: Missing period at end of description for See Also "notna" reference
pandas.DataFrame.notnull: Description should be capitalized for See Also "notna" reference
@syutbai
Copy link
Contributor

syutbai commented Nov 12, 2018

I will try and do this one.

@datapythonista
Copy link
Member Author

@syutbai I'm not sure how it can take to fix all them. If you feel there are too many, feel free to send a pull request fixing just part of them.

@syutbai
Copy link
Contributor

syutbai commented Nov 12, 2018

I also edited "See also" --> "See Also" along the way.

I reduced it to the following:

$ ./scripts/validate_docstrings.py --errors=SA02,SA03 | grep -v "^pandas.Panel."
./scripts/validate_docstrings.py:490: DtypeWarning: Columns (0) have mixed types. Specify dtype option on import or set low_memory=False.  runner.run(test, out=f.write)
pandas.Series.str.find: Missing period at end of description for See Also "rfind" reference
pandas.Series.str.index: Missing period at end of description for See Also "rindex" reference
pandas.Series.str.partition: Missing period at end of description for See Also "rpartition" reference
pandas.Series.str.rfind: Missing period at end of description for See Also "find" reference
pandas.Series.str.rindex: Missing period at end of description for See Also "index" reference
pandas.Series.str.rpartition: Missing period at end of description for See Also "partition" reference
pandas.MultiIndex.from_tuples: Missing period at end of description for See Also "MultiIndex.from_arrays" reference
pandas.MultiIndex.from_tuples: Missing period at end of description for See Also "MultiIndex.from_product" reference
pandas.Period.day: Missing period at end of description for See Also "Period.dayofweek" reference
pandas.Period.day: Missing period at end of description for See Also "Period.dayofyear" reference
pandas.Period.daysinmonth: Missing period at end of description for See Also "Period.days_in_month" reference
pandas.Period.daysinmonth: Missing period at end of description for See Also "Period.dayofyear" reference
pandas.Interval.overlaps: Missing period at end of description for See Also "IntervalArray.overlaps" reference
pandas.Interval.overlaps: Missing period at end of description for See Also "IntervalIndex.overlaps" reference```

@datapythonista
Copy link
Member Author

Great job. We had another issue to fix the See also to See Also, and some of them can be changed twice. I think git may be able to merge the changes in both PRs, as the change is exactly the same. But we may also have a conflict. We'll see, we'll try to merge them when the checks finish and all is green.

@dylanchase
Copy link
Contributor

Hi, can I take a stab at fixing the remaining errors?

@datapythonista
Copy link
Member Author

sure, go ahead

@killerontherun1
Copy link
Contributor

Hey, is this still open? Sort of new to this. I'd like to try my hand at fixing this.

@ChiefMilesEdgeworth
Copy link
Contributor

I just ran the script on those errors today and didn't find any. Are we safe to close this issue?

@datapythonista
Copy link
Member Author

Sure, but add the validation of this error to the CI then (see ci/code_checks.sh, the part of docstrings). Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Clean Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants