Code

Opened 7 years ago

Closed 7 years ago

#5601 closed (fixed)

The Coding Style section in Contributing Docs should mention PEP8 checkers

Reported by: simeon Owned by: simeon
Component: Documentation Version: master
Severity: Keywords: pep8 code style
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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 (1)

docs.diff (947 bytes) - added by simeon 7 years ago.

Download all attachments as: .zip

Change History (3)

Changed 7 years ago by simeon

comment:1 Changed 7 years ago by mboersma

  • Keywords pep8 code style added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Ready for checkin

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

comment:2 Changed 7 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

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

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.