diff options
| author | Florent Xicluna <florent.xicluna@gmail.com> | 2012-12-22 01:44:50 +0100 |
|---|---|---|
| committer | Florent Xicluna <florent.xicluna@gmail.com> | 2012-12-22 01:44:50 +0100 |
| commit | 29aa728bdd110c8742182f6a366625a661512706 (patch) | |
| tree | 1a0c03ec932e50b9b52c26077460be9c8cf79386 | |
| parent | 25a7562446ce6f494aa58d7adb2a252f9acc9988 (diff) | |
| download | pep8-29aa728bdd110c8742182f6a366625a661512706.tar.gz | |
More accurate signature for the StyleGuide and the Checker classes. Fix typos.
| -rw-r--r-- | docs/api.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/api.rst b/docs/api.rst index 09bedb9..53bf956 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -18,10 +18,10 @@ Checker Classes The :class:`StyleGuide` class is used to configure a style guide checker instance to check multiple files. -The :class:`Checker` class can be used to check is a single file. +The :class:`Checker` class can be used to check a single file. -.. autoclass:: StyleGuide(*args, **kwargs) +.. autoclass:: StyleGuide(parse_argv=False, config_file=None, paths=None, report=None, **kwargs) .. automethod:: init_report(reporter=None) .. automethod:: check_files(paths=None) @@ -31,7 +31,7 @@ The :class:`Checker` class can be used to check is a single file. .. automethod:: ignore_code(code) .. automethod:: get_checks(argument_name) -.. autoclass:: Checker(filename=None, lines=None, options=None, report=None, **kwargs) +.. autoclass:: Checker(filename=None, lines=None, report=None, **kwargs) .. automethod:: readline .. automethod:: readline_check_physical @@ -40,7 +40,7 @@ The :class:`Checker` class can be used to check is a single file. .. automethod:: build_tokens_line .. automethod:: check_logical .. automethod:: generate_tokens - .. automethod:: check_all(expected=None, line_offset=1) + .. automethod:: check_all(expected=None, line_offset=0) .. _report_classes: |