Skip to content

Commit ce7bbad

Browse files
hauntsaninjacdce8p
andauthored
Apply suggestions from code review
Co-authored-by: Marc Mueller <[email protected]>
1 parent c1f54f1 commit ce7bbad

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

docs/source/command_line.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,9 +170,11 @@ imports.
170170

171171
This flag makes mypy analyze imports even if missing a py.typed marker or stubs.
172172

173-
Note that analyzing all unannotated modules might result in issues
174-
when analyzing code not designed to be type checked and may significantly
175-
increase how long mypy takes to run.
173+
.. warning::
174+
175+
Note that analyzing all unannotated modules might result in issues
176+
when analyzing code not designed to be type checked and may significantly
177+
increase how long mypy takes to run.
176178

177179
.. option:: --follow-imports {normal,silent,skip,error}
178180

docs/source/config_file.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -322,14 +322,16 @@ section of the command line docs.
322322

323323
Makes mypy analyze imports even if missing a py.typed marker or stubs.
324324

325-
Note that analyzing all unannotated modules might result in issues
326-
when analyzing code not designed to be type checked and may significantly
327-
increase how long mypy takes to run.
328-
329325
If this option is used in a per-module section, the module name should
330326
match the name of the *imported* module, not the module containing the
331327
import statement.
332328

329+
.. warning::
330+
331+
Note that analyzing all unannotated modules might result in issues
332+
when analyzing code not designed to be type checked and may significantly
333+
increase how long mypy takes to run.
334+
333335
.. confval:: follow_imports
334336

335337
:type: string

docs/source/running_mypy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ If you are getting this error, try to obtain type hints for the library you're u
278278
:ref:`PEP 561 compliant packages <installed-packages>`.
279279

280280
4. Force mypy to analyze the library as best as it can (as if the library provided
281-
a py.typed file), despite it likely missing any type annotations. In general,
281+
a ``py.typed`` file), despite it likely missing any type annotations. In general,
282282
the quality of type checking will be poor and mypy may have issues when
283283
analyzing code not designed to be type checked.
284284

0 commit comments

Comments
 (0)