diff options
| author | Torsten Marek <shlomme@gmail.com> | 2014-03-30 15:54:13 -0700 |
|---|---|---|
| committer | Torsten Marek <shlomme@gmail.com> | 2014-03-30 15:54:13 -0700 |
| commit | 96d7c29483500c90882f6d69e3328a5926183c47 (patch) | |
| tree | 65f0633638483694ba2379296a4a5a19257ce729 /doc | |
| parent | 4d9e83a9c8e04383da565bfa188c583e193750c1 (diff) | |
| download | pylint-96d7c29483500c90882f6d69e3328a5926183c47.tar.gz | |
Make it possible to show a naming hint for invalid name by setting include-naming-hint. Also make the naming hints configurable.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/options.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/options.rst b/doc/options.rst index ec17fb0..4a159f2 100644 --- a/doc/options.rst +++ b/doc/options.rst @@ -126,3 +126,14 @@ prevent built-in or interface-dictated names to trigger certain naming styles. Format: comma-separated groups of colon-separated names. This option can be used to combine name styles. For example, ``function:method`` enforces that functions and methods use the same style, and a style triggered by either name type carries over to the other. This requires that the regular expression for the combined name types use the same group names. + +Name Hints +^^^^^^^^^^ + +.. option:: --include-naming-hint=y|n + + Default: off + + Include a hint for the correct name format with every ``invalid-name`` warning. + + Name hints default to the regular expression, but can be separately configured with the ``--<name-type>-hint`` options. |