Skip to content

Commit

Permalink
Update docs for warning fields
Browse files Browse the repository at this point in the history
  • Loading branch information
mpeterv committed Mar 2, 2017
1 parent 4016412 commit 00c1f8e
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions docsrc/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,20 @@ A file report is an array of issues (warnings or errors). If a fatal error occur

An issue is a table with field ``code`` indicating its type (see :doc:`warnings`), and fields ``line``, ``column`` and ``end_column`` pointing to the source of the warning. ``name`` field may contain name of related variable. Issues of some types can also have additional fields:

===== ========================================================================================
Codes Additional fields
===== ========================================================================================
011 ``msg`` field contains syntax error message.
111 ``module`` field indicates that assignment is to a non-module global variable.
122 ``indirect`` field indicates that the global was mutated using a local alias.
211 ``func`` field indicates that unused variable is a function.
211 ``recursive`` field indicates that unused function is recursive.
211 ``mutually_recursive`` field is set for unused mutually recursive functions.
314 ``field`` field contains string representation of ununsed field or index.
4.. ``prev_line`` and ``prev_column`` fields contain location of the overwritten definition.
521 ``label`` field contains label name.
631 ``max_length`` field contains maximum allowed line length.
===== ========================================================================================
============= ========================================================================================
Codes Additional fields
============= ========================================================================================
011 ``msg`` field contains syntax error message.
111 ``module`` field indicates that assignment is to a non-module global variable.
122, 142, 143 ``indirect`` field indicates that the global field was accessed using a local alias.
122, 142, 143 ``field`` field contains string representation of related global field.
211 ``func`` field indicates that unused variable is a function.
211 ``recursive`` field indicates that unused function is recursive.
211 ``mutually_recursive`` field is set for unused mutually recursive functions.
314 ``field`` field contains string representation of ununsed field or index.
4.. ``prev_line`` and ``prev_column`` fields contain location of the overwritten definition.
521 ``label`` field contains label name.
631 ``max_length`` field contains maximum allowed line length.
============= ========================================================================================

Other fields may be present for internal reasons.

0 comments on commit 00c1f8e

Please sign in to comment.