Fix validation error type `SS03` and check in CI

[MarckK]

Problem description

In order to have a continuous check by the CI on validation error SS03 (Summary does not end with a period), fixing them in the code base enables the addition to the CI for automated testing in the future.

SS03 has 178 occurrences (see overview of the errors), including:

method	file	file_line	github_link
pandas.Timestamp	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.max	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.min	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.resolution	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.tz	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.ceil	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.combine	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.floor	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.fromordinal	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.isoweekday	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.replace	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.round	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.to_datetime64	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.weekday	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.components	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.view	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.ceil	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.floor	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.isoformat	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.round	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.to_pytimedelta	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.to_timedelta64	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timedelta.total_seconds	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Period	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Period.asfreq	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Period.strftime	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Period.to_timestamp	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Interval.closed	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Interval.left	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Interval.length	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
...	...	...	...
pandas.tseries.offsets.CBMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CBMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CDay.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.frequencies.to_offset	pandas/tseries/frequencies.py	59.0	https://github.com/pandas-dev/pandas/blob/master/pandas/tseries/frequencies.py#L59
pandas.Panel.axes	pandas/core/generic.py	441.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L441
pandas.Panel.shape	pandas/core/generic.py	434.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L434
pandas.Panel.iter	pandas/core/generic.py	1819.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L1819
pandas.Panel.iteritems	pandas/core/generic.py	1832.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L1832
pandas.Panel.lt	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.gt	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.le	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.ge	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.ne	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.eq	pandas/core/ops.py	2170.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/ops.py#L2170
pandas.Panel.swaplevel	pandas/core/generic.py	932.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L932
pandas.Panel.transpose	pandas/core/panel.py	1269.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/panel.py#L1269
pandas.plotting.deregister_matplotlib_converters	pandas/plotting/_converter.py	88.0	https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/_converter.py#L88
pandas.plotting.register_matplotlib_converters	pandas/plotting/_converter.py	55.0	https://github.com/pandas-dev/pandas/blob/master/pandas/plotting/_converter.py#L55
pandas.core.resample.Resampler.first	pandas/core/resample.py	857.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L857
pandas.core.resample.Resampler.last	pandas/core/resample.py	857.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L857
pandas.core.resample.Resampler.max	pandas/core/resample.py	857.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L857
pandas.core.resample.Resampler.min	pandas/core/resample.py	857.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L857
pandas.core.resample.Resampler.prod	pandas/core/resample.py	846.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L846
pandas.core.resample.Resampler.sum	pandas/core/resample.py	846.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/resample.py#L846
pandas.io.formats.style.Styler.loader	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.io.formats.style.Styler.set_caption	pandas/io/formats/style.py	778.0	https://github.com/pandas-dev/pandas/blob/master/pandas/io/formats/style.py#L778
pandas.Panel.items	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Panel.keys	pandas/core/generic.py	1824.0	https://github.com/pandas-dev/pandas/blob/master/pandas/core/generic.py#L1824
pandas.Panel.major_axis	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Panel.minor_axis	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone

Todo:

• get rid of the errors in the code base
• update the code_check.sh script to take into account the SS03 type of errors

[nickagian]

Hi, can I work on this?

[MarckK]

All yours @nickagian! :)

[nickagian]

I have gone down to 51 errors, which are very tricky and don't know how to handle them. Could someone help?

Here the list of the remaining errors:

method	file	file_line	github_link
pandas.Timestamp.isoweekday	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.weekday	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.DateOffset.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BusinessDay.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BusinessHour.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CustomBusinessDay.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CustomBusinessHour.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.MonthOffset.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.MonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.MonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BusinessMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BusinessMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CustomBusinessMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CustomBusinessMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.SemiMonthOffset.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.SemiMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.SemiMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Week.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.WeekOfMonth.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.LastWeekOfMonth.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.QuarterOffset.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BQuarterEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BQuarterBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.QuarterEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.QuarterBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.YearOffset.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BYearEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BYearBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.YearEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.YearBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.FY5253.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.FY5253Quarter.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Easter.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Tick.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Day.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Hour.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Minute.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Second.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Milli.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Micro.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.Nano.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BDay.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.BMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CBMonthEnd.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CBMonthBegin.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.tseries.offsets.CDay.normalize	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.io.formats.style.Styler.loader	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Panel.items	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Panel.major_axis	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Panel.minor_axis	None	NaN	https://github.com/pandas-dev/pandas/blob/master/None#LNone

From the above:

• For all the normalize attributes, I believe there no docstring existing actually. Because when I try to print it, I get the generic docstring for the bool class.

• pandas.Timestamp.isoweekday and pandas.Timestamp.weekday seem to come directly from the datetime.date object.

• For the pandas.io.formats.style.Styler.loader attribute, the docstring seems to come directly from the jinja2 module.

• The docstring for attributes items, major_axis and minor_axis of Panel class, is only their name, e.g. just "items" for items. I don't understand where can I change this.

[parkerdgabel]

Hi I would like to help but i'm not quite sure what the problem is or how it is solved. Is it a missing period in a docstring?

[nickagian]

Yes, the summary of the docstring should end with a period.
As I said, I have eliminated almost all of them, but there seems to be three categories that it is a bit trickier:

• One category where the docstring comes directly from an external module (we cannot really change that, perhaps create an issue over there?)

• Another is the attributes items, major_axis and minor_axis of Panel class: there doesn't seem to be any real docstring here. One gets just the names of the attributes instead. So perhaps we should create an issue for new docstring to be added here.

• And the third is a bunch occurrences of the normalize attribute. Here again, no special dosctring exists and since it is a bool attribute, the docstring of the bool class is printed, which doesn't have a period at the end of the summary.