Skip to content

Fix validation error type SS02 and check in CI #25113

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.

Sign up for GitHub

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

Jump to bottom
Closed
2 tasks
kynan opened this issue Feb 3, 2019 · 6 comments · Fixed by #37559
Closed
2 tasks

Fix validation error type SS02 and check in CI #25113

kynan opened this issue Feb 3, 2019 · 6 comments · Fixed by #37559
Labels
CI Continuous Integration Code Style Code style, linting, code_checks Docs good first issue
Milestone
1.2

Comments

@kynan
Copy link
Contributor

kynan commented Feb 3, 2019 •
edited
Loading

Problem description

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

SS02 has just 61 occurrences (see overview of the errors):

method file file_line github_link
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.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.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.fromtimestamp 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.strftime None NaN https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.Timestamp.strptime 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.to_pytimedelta None NaN https://github.com/pandas-dev/pandas/blob/master/None#LNone
pandas.HDFStore.groups pandas/io/pytables.py 1093.0 https://github.com/pandas-dev/pandas/blob/master/pandas/io/pytables.py#L1093
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

Todo:

  • get rid of the errors in the code base
  • update the code_check.sh script to take into account the SS02 type of errors
@jorisvandenbossche jorisvandenbossche added this to the Contributions Welcome milestone Feb 3, 2019
@souvik3333
Copy link
Contributor

Hi, can I work on this?

@thoo
Copy link
Contributor

thoo commented Feb 4, 2019

@souvik3333 Sure.

@souvik3333
Copy link
Contributor

Thanks @thoo, Can you please tell me how to find the error causing lines as most of them are not mentioned.

@souvik3333 souvik3333 mentioned this issue Feb 18, 2019
Closed
4 tasks
@gfyoung gfyoung added CI Continuous Integration Code Style Code style, linting, code_checks labels Feb 18, 2019
@abhishekmangla
Copy link
Contributor

take

abhishekmangla added a commit to abhishekmangla/pandas that referenced this issue Nov 1, 2020
@abhishekmangla
CLN: Add SS02 check to code_checks.sh (pandas-dev#25113)
42b6d0b
@abhishekmangla abhishekmangla mentioned this issue Nov 1, 2020
Merged
5 tasks
@abhishekmangla
Copy link
Contributor

@jorisvandenbossche For visibility.

I am encountering just one case where SS02 fails:
##[error]None:None:SS02:pandas.Timestamp.strftime:Summary does not start with a capital letter

I can't find the docstring for this method in the codebase, maybe it is being lifted from python's datetime module?

@jorisvandenbossche
Copy link
Member

Indeed, we inherit that method from the stdlib datetime.datetime, so don't directly control the docstring. I think it would be nice to have a better docstring though. See also #36745 for related discussion

@jreback jreback modified the milestones: Contributions Welcome, 1.2 Nov 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI Continuous Integration Code Style Code style, linting, code_checks Docs good first issue
Projects
None yet
Milestone
1.2
Development

Successfully merging a pull request may close this issue.

Add ss02 abhishekmangla/pandas
7 participants
@kynan @jreback @jorisvandenbossche @thoo @gfyoung @abhishekmangla @souvik3333