Skip to content

Commit 5464ab3

Browse files
author
Kevin Burke
committed
refactor the style page.
1 parent 574ab18 commit 5464ab3

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/writing/style.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ Also known as PEP 20, the guiding principles for Python's design.
3838
If the implementation is easy to explain, it may be a good idea.
3939
Namespaces are one honking great idea -- let's do more of those!
4040

41-
See `<http://stackoverflow.com/questions/228181/the-zen-of-python>`_ for some
42-
examples.
41+
For some examples of good Python style, see `this Stack Overflow question
42+
<http://stackoverflow.com/questions/228181/the-zen-of-python>`_ or `these
43+
slides from a Python user group
44+
<http://artifex.org/~hblanks/talks/2011/pep20_by_example.pdf>`_.
4345

4446
PEP 8
4547
-----
@@ -48,16 +50,17 @@ PEP 8 is the de-facto code style guide for Python.
4850

4951
`PEP 8 <http://www.python.org/dev/peps/pep-0008/>`_
5052

51-
There exists a command-line program, `pep8` that can check your code for
52-
conformance.
53+
Conforming your Python code to PEP 8 is generally a good idea and helps make
54+
code more consistent when working on projects with other developers. There
55+
exists a command-line program, `pep8 <https://github.com/jcrocholl/pep8>`_,
56+
that can check your code for conformance.
5357

5458
::
5559

56-
pip install pep8
60+
$ pip install pep8
5761

5862

59-
Simply run it on a file or series of files and get a report of any
60-
violations
63+
Simply run it on a file or series of files to get a report of any violations.
6164

6265
::
6366

@@ -71,5 +74,3 @@ violations
7174
optparse.py:472:29: E221 multiple spaces before operator
7275
optparse.py:544:21: W601 .has_key() is deprecated, use 'in'
7376

74-
Conforming your style to PEP 8 is generally a good idea and helps make code a lot
75-
more consistent when working on projects with other developers.

0 commit comments

Comments
 (0)