Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Do One Thing Only

Include:

Comments

C1: Inappropriate Information

Comments should not include information better captured elsewhere.

C2: Obsolete Comments *

Get rid of or update ASAP

C3: Redundant Comments

C4: Poorly Written Comments

A comment worth writing is worth writing well.  We value this enough to discuss comment quality in code review.  Be kind to committers.  Suggest documentation wording when appropriate.

C5: Commented out code

It should not be checked in.  Delete it when you find it. (BSR)

Functions

F1: Too many arguments *

*kwargs

*zero?

F3: Boolean arguments

...