Enforce PEP8 coding convention - D400:First line should end with a period.

Bug #1562250 reported by Prosunjit Biswas
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Wishlist
Navid Pustchi

Bug Description

Current Keystone code base ignores some of the PEP8 coding conventions. The ignored conventions for the keystone project are listed here

https://github.com/openstack/keystone/blob/master/tox.ini#L118

Some of the coding conventions that have been put in the ignored list, are indeed not violated. For example, in current codebase the following two coding conventions are not violated at all.

# D203: 1 blank required before class docstring.
# D205: Blank line required between one-line summary and description.

On the other hand, some violated conventions are relatively easy to fix . For example,

#D400: First line should end with a period.

List of all files violating D400 are given here : https://gist.github.com/Prosunjit/1449708c550364b56ca0

Most of the files that violate D400 are test script (in the keystone/tests directory), which can be ignored, I guess.

So, this is easy to fix and should be fixed.

Changed in keystone:
assignee: nobody → Prosunjit Biswas (prosun-csedu)
description: updated
description: updated
Revision history for this message
Steve Martinelli (stevemar) wrote :

This is not a bug. There is no external impact to end-users. Please go ahead and fix this issue, we have done so in the past: https://github.com/openstack/keystone/commit/4bc9dacd7e495f3b6a88bd8fac05d7e9a84c4672 but have never required a bug.

Changed in keystone:
importance: Low → Wishlist
Changed in keystone:
assignee: Prosunjit Biswas (prosun-csedu) → Steve Martinelli (stevemar)
status: New → In Progress
Revision history for this message
Steve Martinelli (stevemar) wrote :
Revision history for this message
Morgan Fainberg (mdrnstm) wrote :

I am against this type of hacking change. I don't see a benefit to forcing punctuation for the first line of a docstring this is similar to my view of the period/no period for commit messages.

I vote we simply keep ignoring D400 indefinitely.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on keystone (master)

Change abandoned by Steve Martinelli (<email address hidden>) on branch: master
Review: https://review.openstack.org/297965

Revision history for this message
Steve Martinelli (stevemar) wrote :
Changed in keystone:
assignee: Steve Martinelli (stevemar) → Navid Pustchi (npustchi)
milestone: none → newton-1
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.