diff --git a/docs/index.rst b/docs/index.rst index c0f429f..f5aae99 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,13 +6,13 @@ Documentation .. toctree:: - api - extensions config + warnings vcs buildout setuptools - warnings + api + extensions changes Original Projects diff --git a/docs/vcs.rst b/docs/vcs.rst index 5b938f6..444d607 100644 --- a/docs/vcs.rst +++ b/docs/vcs.rst @@ -30,7 +30,7 @@ Git hook To use the Git hook on any *commit*, add a **pre-commit** file in the *.git/hooks* directory containing:: - #!/usr/bin/python + #!/usr/bin/env python import sys from flake8.run import git_hook diff --git a/flake8/hooks.py b/flake8/hooks.py index bd6ba33..4d5eb3b 100644 --- a/flake8/hooks.py +++ b/flake8/hooks.py @@ -14,7 +14,7 @@ from flake8.main import DEFAULT_CONFIG def git_hook(complexity=-1, strict=False, ignore=None, lazy=False): """This is the function used by the git hook. - + :param int complexity: (optional), any value > 0 enables complexity checking with mccabe :param bool strict: (optional), if True, this returns the total number of diff --git a/flake8/main.py b/flake8/main.py index 692e9f4..2f5c851 100644 --- a/flake8/main.py +++ b/flake8/main.py @@ -42,8 +42,7 @@ def main(): def check_file(path, ignore=(), complexity=-1): - """Checks a file using pep8 and pyflakes by default and mccabe - optionally. + """Checks a file using pep8 and pyflakes by default and mccabe optionally. :param str path: path to the file to be checked :param tuple ignore: (optional), error and warning codes to be ignored