Skip to content

Commit

Permalink
Unbitrot the PyFlakes page.
Browse files Browse the repository at this point in the history
* Convert markup syntax from whatever-it-was to ReStructuredText.

* Point to the current 0.5.0 release.

* Replace broken links to tarball and source repository with current ones.

* Drop the Freshmeat link altogether (Freshmeat disclaims any knowledge
  about PyFlakes).

* Mention PyLint as an alternative tool.
  • Loading branch information
mgedmin committed Dec 14, 2011
1 parent 7d4b4a1 commit 1ce363f
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions products/pyflakes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
Divmod PyFlakes
===============

PyFlakes a Lint-like tool for Python, like `PyChecker`_. It is focused on
identifying common errors quickly without executing Python code.
PyFlakes a Lint-like tool for Python, like `PyChecker`_ or `PyLint`_. It is
focused on identifying common errors quickly without executing Python code.

Its primary advantage over PyChecker is that it is *fast*. You don't have to
sit around for minutes waiting for the checker to run; it runs on most large
projects in only a few seconds.

The two primary categories of defects reported by PyFlakes are:

* Names which are used but not defined or used before they are defined
* Names which are redefined without having been used
* Names which are used but not defined or used before they are defined
* Names which are redefined without having been used

These can each take many forms. For example, PyFlakes will tell you when you
have forgotten an import, mistyped a variable name, defined two functions with
Expand All @@ -22,15 +22,18 @@ twice, or two different modules with the same name, and so on.
Download
========

* [http://divmod.org/trac/attachment/wiki/SoftwareReleases/pyflakes-0.4.0.tar.gz?format=raw 0.4.0 Release] ([http://divmod.org/trac/browser/tags/releases/Pyflakes-0.4.0/NEWS.txt Release Notes])
* Trunk: svn co http://divmod.org/svn/Divmod/trunk/Pyflakes !PyFlakes
* `0.5.0 Release <http://pypi.python.org/packages/source/p/pyflakes/pyflakes-0.5.0.tar.gz#md5=568dab27c42e5822787aa8a603898672>`_
(`Release Notes <http://bazaar.launchpad.net/~divmod-dev/divmod.org/trunk/view/2681.1.2/Pyflakes/NEWS.txt>`_)
or ``pip install pyflakes``
* Trunk: ``bzr branch lp:divmod.org && cd divmod.org/PyFlakes``
(`Browse <http://bazaar.launchpad.net/~divmod-dev/divmod.org/trunk/view/head:/Pyflakes/>`_)

Exits
=====

* [http://pypi.python.org/pypi/pyflakes PyFlakes on PyPI]
* [https://launchpad.net/pyflakes PyFlakes on launchpad]
* [http://www.freshmeat.net/projects/pyflakes PyFlakes on freshmeat]
* [http://www.swik.net/pyflakes PyFlakes on swik]
* `PyFlakes on PyPI <http://pypi.python.org/pypi/pyflakes>`_
* `PyFlakes on Launchpad <https://launchpad.net/pyflakes>`_
* `PyFlakes on SWiK <http://www.swik.net/pyflakes>`_

.. _PyChecker: http://pychecker.sourceforge.net
.. _PyLint: http://pypi.python.org/pypi/pylint

0 comments on commit 1ce363f

Please sign in to comment.