Darglint

Changed

- Update the line numbers to be closer to the actual source of problems.

Changed

- Change the parser to a recursive descent parser. This allows
greater precision and flexibility. It will also make it possible
to capture and pass along line numbers.

Added

- Line numbers added to `Token`s. The line numbers are added
and incremented in the `lex()` function.

Added

- Message templates for error reports based on Pylint's syntax.
The message template uses a normal Python format string with
named arguments. For example, the default format string
for an error message is '{path}:{obj}:{line}: {msg_id}: {msg}'.

This is passed to the linter by a command-line argument.
For example, to get only the path, line number, and error code,
we could pass something like the following:


darglint -m "{path}:{line} -> {msg_id}" *.py


This value can also be specified in the configuration file
as the value, `message_template`. For example, the above
template could have been specified in the configuration
as


[darglint]
message_template={path}:{line} -> {msg_id}

Added

- Added support for Python3.5. Probably earlier versions of Python
can also be supported, but they need to be tested, first.

- Added *tox* script for running tests against all environments.
To run the tests, make sure the test dependencies are installed,
and run


tox

Added

- Allow global noqa statements in docstring. If we have a docstring
which we would like to ignore (say, because it has a different
format), then we can ignore it either by adding " noqa" or
" noqa: \*" to it.

For example, the following program would raise an exception that
there is a missing "Returns" section:


def is_palindrome(word):
"""True if the word is a palindrome.

noqa

"""
return word == word[::-1]


However, since there is a global noqa statement, all errors are
ignored.