Skip to content

Commit

Permalink
[1.0 backport] [used before def] add documentation (#14592) (#14597)
Browse files Browse the repository at this point in the history
Adding documentation for used-before-def check.
  • Loading branch information
ilinum authored Feb 3, 2023
1 parent 8ef98cc commit c2876bf
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/source/error_code_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,23 @@ This example accidentally calls ``sort()`` instead of :py:func:`sorted`:
x = sort([3, 2, 4]) # Error: Name "sort" is not defined [name-defined]
Check that a variable is not used before it's defined [used-before-def]
-----------------------------------------------------------------------

Mypy will generate an error if a name is used before it's defined.
While the name-defined check will catch issues with names that are undefined,
it will not flag if a variable is used and then defined later in the scope.
used-before-def check will catch such cases.

Example:

.. code-block:: python
print(x) # Error: Name "x" is used before definition [used-before-def]
x = 123
Check arguments in calls [call-arg]
-----------------------------------

Expand Down

0 comments on commit c2876bf

Please sign in to comment.