Opened 9 years ago

Closed 9 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:


I just discovered at 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 ``_ 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 9 years ago.

Download all attachments as: .zip

Change History (3)

Changed 9 years ago by simeon

comment:1 Changed 9 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 is very useful and it can't hurt to point it out when talking about coding style.

comment:2 Changed 9 years ago by mtredinnick

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

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

Note: See TracTickets for help on using tickets.
Back to Top