summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorent Xicluna <florent.xicluna@gmail.com>2012-06-17 10:34:44 +0200
committerFlorent Xicluna <florent.xicluna@gmail.com>2012-06-17 10:34:44 +0200
commitad28d340b5f93df534e0b45243e4d7fa5fecd518 (patch)
treea4b8c7aee2266e42976448b9cc31da4cdba11b2d
parentaf843f1c5432fbfeb70c43188166af1a99834a02 (diff)
downloadpep8-ad28d340b5f93df534e0b45243e4d7fa5fecd518.tar.gz
Refresh the README and the CHANGES.
-rw-r--r--CHANGES.txt3
-rw-r--r--README.rst16
-rwxr-xr-xpep8.py2
3 files changed, 15 insertions, 6 deletions
diff --git a/CHANGES.txt b/CHANGES.txt
index 98af24c..c87b986 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -5,7 +5,8 @@ Changelog
1.x (UNRELEASED)
----------------
-* Explain which configuration options are expected. (Issue #82)
+* Explain which configuration options are expected. Accept and recommend
+ the options names with hyphen instead of underscore. (Issue #82)
* Fix wrong or missing cases for the E12 series.
diff --git a/README.rst b/README.rst
index 6387b0e..e68714d 100644
--- a/README.rst
+++ b/README.rst
@@ -105,15 +105,23 @@ Quick help is available on the command line::
--statistics count errors and warnings
--count print total number of errors and warnings to standard
error and set exit code to 1 if total is not null
- --benchmark measure processing speed
- --testsuite=dir run regression tests from dir
--max-line-length=n set maximum allowed line length (default: 79)
- --doctest run doctest on myself
- --config=path config file location (default: /home/user/.config/pep8)
--format=format set the error format [default|pylint|<custom>]
--diff report only lines changed according to the unified diff
received on STDIN
+ Testing Options:
+ --testsuite=dir run regression tests from dir
+ --doctest run doctest on myself
+ --benchmark measure processing speed
+
+ Configuration:
+ The configuration options are read from the [pep8] section. Allowed
+ options are: exclude, filename, select, ignore, max-line-length,
+ count, format, quiet, show-pep8, show-source, statistics.
+
+ --config=path config file location (default: /home/user/.config/pep8)
+
Feedback
--------
diff --git a/pep8.py b/pep8.py
index 95c50f7..fa3c47a 100755
--- a/pep8.py
+++ b/pep8.py
@@ -110,7 +110,6 @@ try:
except ImportError:
from ConfigParser import RawConfigParser
-
DEFAULT_EXCLUDE = '.svn,CVS,.bzr,.hg,.git'
DEFAULT_IGNORE = 'E24'
DEFAULT_CONFIG = os.path.join(
@@ -122,6 +121,7 @@ REPORT_FORMAT = {
'pylint': '%(path)s:%(row)d: [%(code)s] %(text)s',
}
+
SINGLETONS = frozenset(['False', 'None', 'True'])
KEYWORDS = frozenset(keyword.kwlist + ['print']) - SINGLETONS
BINARY_OPERATORS = frozenset([