yahoo-eng-team team mailing list archive

["Matthew D. Wood" <woodm1979@xxxxxxxxx>]

Public bug reported:

Whitespace should be consistent inside of settings.py and
local_settings.py.example.

Currently, most comments in side our settings files follow the "space
after # mark" guideline.  This is as it should be.  However, commented
out code-lines are inconsistently including that space.  Most of the
time they don't include it.

There's a case to be made for either approach:

Do include the space after the #: 
    Keeps things consistent and it's how pyflakes likes things.

Do not include the space after the #:
    Identifies the commented out line as potential code, instead of a descriptive comment.
    Makes it easier to just remove the '#' character to activate the line of code.  Specifically with python, leaving the white space is likely bad.

An informal survey of the lines in these files shows that most commented
out code lines do not have a space, and I agree with that policy.  I'd
like to make this the policy and clean up the code.

** Affects: horizon
     Importance: Undecided
     Assignee: Matthew D. Wood (woodm1979)
         Status: New

** Summary changed:

- local_settings.py
+ Whitespace inside settings files

** Changed in: horizon
     Assignee: (unassigned) => Matthew D. Wood (woodm1979)

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Dashboard (Horizon).
https://bugs.launchpad.net/bugs/1428222

Title:
  Whitespace inside settings files

Status in OpenStack Dashboard (Horizon):
  New

Bug description:
  Whitespace should be consistent inside of settings.py and
  local_settings.py.example.

  Currently, most comments in side our settings files follow the "space
  after # mark" guideline.  This is as it should be.  However, commented
  out code-lines are inconsistently including that space.  Most of the
  time they don't include it.

  There's a case to be made for either approach:

  Do include the space after the #: 
      Keeps things consistent and it's how pyflakes likes things.

  Do not include the space after the #:
      Identifies the commented out line as potential code, instead of a descriptive comment.
      Makes it easier to just remove the '#' character to activate the line of code.  Specifically with python, leaving the white space is likely bad.

  An informal survey of the lines in these files shows that most
  commented out code lines do not have a space, and I agree with that
  policy.  I'd like to make this the policy and clean up the code.

To manage notifications about this bug go to:
https://bugs.launchpad.net/horizon/+bug/1428222/+subscriptions