Skip to content

Commit 9e98209

Browse files
fix some typos / confusing language I found along the way
1 parent 465ea8c commit 9e98209

File tree

5 files changed

+14
-11
lines changed

5 files changed

+14
-11
lines changed

docs/source/command_line.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ definitions or calls.
372372

373373
.. option:: --untyped-calls-exclude
374374

375-
This flag allows to selectively disable :option:`--disallow-untyped-calls`
375+
This flag allows one to selectively disable :option:`--disallow-untyped-calls`
376376
for functions and methods defined in specific packages, modules, or classes.
377377
Note that each exclude entry acts as a prefix. For example (assuming there
378378
are no type annotations for ``third_party_lib`` available):
@@ -562,7 +562,7 @@ potentially problematic or redundant in some way.
562562

563563
.. option:: --deprecated-calls-exclude
564564

565-
This flag allows to selectively disable :ref:`deprecated<code-deprecated>` warnings
565+
This flag allows one to selectively disable :ref:`deprecated<code-deprecated>` warnings
566566
for functions and methods defined in specific packages, modules, or classes.
567567
Note that each exclude entry acts as a prefix. For example (assuming ``foo.A.func`` is deprecated):
568568

docs/source/error_code_list.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,8 +1003,8 @@ Warn about top level await expressions [top-level-await]
10031003
This error code is separate from the general ``[syntax]`` errors, because in
10041004
some environments (e.g. IPython) a top level ``await`` is allowed. In such
10051005
environments a user may want to use ``--disable-error-code=top-level-await``,
1006-
that allows to still have errors for other improper uses of ``await``, for
1007-
example:
1006+
which allows one to still have errors for other improper uses of ``await``,
1007+
for example:
10081008

10091009
.. code-block:: python
10101010

docs/source/error_code_list2.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -458,9 +458,12 @@ Example:
458458
# Error: unused "type: ignore" comment
459459
return a + b # type: ignore
460460
461-
Note that due to a specific nature of this comment, the only way to selectively
462-
silence it, is to include the error code explicitly. Also note that this error is
463-
not shown if the ``# type: ignore`` is not used due to code being statically
461+
Mypy errors can typically be silenced by putting a ``# type: ignore`` comment after them,
462+
but because this is *already* a ``# type: ignore`` comment, the only way to selectively
463+
silence it is to include the error code explicitly, making the comment
464+
``# type: ignore[unused-ignore]``.
465+
466+
This error is not shown if the ``# type: ignore`` is not used due to code being statically
464467
unreachable (e.g. due to platform or version checks).
465468

466469
Example:

docs/source/mypy_daemon.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,16 +252,16 @@ command.
252252
Statically inspect expressions
253253
******************************
254254

255-
The daemon allows to get declared or inferred type of an expression (or other
255+
The daemon allows one to get the declared or inferred type of an expression (or other
256256
information about an expression, such as known attributes or definition location)
257-
using ``dmypy inspect LOCATION`` command. The location of the expression should be
257+
using the ``dmypy inspect LOCATION`` command. The location of the expression should be
258258
specified in the format ``path/to/file.py:line:column[:end_line:end_column]``.
259259
Both line and column are 1-based. Both start and end position are inclusive.
260260
These rules match how mypy prints the error location in error messages.
261261

262262
If a span is given (i.e. all 4 numbers), then only an exactly matching expression
263263
is inspected. If only a position is given (i.e. 2 numbers, line and column), mypy
264-
will inspect all *expressions*, that include this position, starting from the
264+
will inspect all expressions that include this position, starting from the
265265
innermost one.
266266

267267
Consider this Python code snippet:

mypy/traverser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -504,7 +504,7 @@ class ExtendedTraverserVisitor(TraverserVisitor):
504504
In addition to the base traverser it:
505505
* has visit_ methods for leaf nodes
506506
* has common method that is called for all nodes
507-
* allows to skip recursing into a node
507+
* allows skipping recursing into a node
508508
509509
Note that this traverser still doesn't visit some internal
510510
mypy constructs like _promote expression and Var.

0 commit comments

Comments
 (0)