Django

Code

Ticket #5601 (closed: fixed)

Opened 1 year ago

Last modified 10 months ago

The Coding Style section in Contributing Docs should mention PEP8 checkers

Reported by: simeon Assigned to: simeon
Milestone: Component: Documentation
Version: SVN Keywords: pep8 code style
Cc: Triage Stage: Ready for checkin
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

Description

I just discovered pep8.py at http://svn.browsershots.org/trunk/devtools/pep8/ and consequently removed some style issues from a patch I submitted that I wouldn't have seen otherwise (whitespace and trailing semi-colons). Perhaps more experienced Python devs are familiar with this or similar tools but I thought it might not be a bad idea to point to it in the docs. I just added the text 

(use `pep8.py`_ to check).

to the end of the line about PEP 8 in the Coding Style section of the contributing.txt doc page (and appended the link to the bottom of the page).

Attachments

docs.diff (0.9 kB) - added by simeon on 09/25/07 15:33:08.

Change History

09/25/07 15:33:08 changed by simeon

  • attachment docs.diff added.

09/25/07 15:45:23 changed by mboersma

  • keywords set to pep8 code style.
  • needs_better_patch changed.
  • stage changed from Unreviewed to Ready for checkin.
  • needs_tests changed.
  • needs_docs changed.

I agree--pep8.py is very useful and it can't hurt to point it out when talking about coding style.

10/20/07 05:41:56 changed by mtredinnick

  • status changed from new to closed.
  • resolution set to fixed.

(In [6560]) Fixed #5601 -- Point out the existence of pep8.py for people wanting some extra help checking for consistency. Thanks, simeon.

Add/Change #5601 (The Coding Style section in Contributing Docs should mention PEP8 checkers)




Change Properties
Action