Skip to content

Commit c09118b

Browse files
Update command_line.rst: instead of moving experimental features up, move it down, pt1
1 parent 576ebbb commit c09118b

File tree

1 file changed

+61
-59
lines changed

1 file changed

+61
-59
lines changed

docs/source/command_line.rst

Lines changed: 61 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1096,6 +1096,67 @@ in developing or debugging mypy internals.
10961096
cause mypy to type check the contents of ``temp.py`` instead of ``original.py``,
10971097
but error messages will still reference ``original.py``.
10981098

1099+
1100+
Report generation
1101+
*****************
1102+
1103+
If these flags are set, mypy will generate a report in the specified
1104+
format into the specified directory.
1105+
1106+
.. option:: --any-exprs-report DIR
1107+
1108+
Causes mypy to generate a text file report documenting how many
1109+
expressions of type ``Any`` are present within your codebase.
1110+
1111+
.. option:: --cobertura-xml-report DIR
1112+
1113+
Causes mypy to generate a Cobertura XML type checking coverage report.
1114+
1115+
To generate this report, you must either manually install the `lxml`_
1116+
library or specify mypy installation with the setuptools extra
1117+
``mypy[reports]``.
1118+
1119+
.. option:: --html-report / --xslt-html-report DIR
1120+
1121+
Causes mypy to generate an HTML type checking coverage report.
1122+
1123+
To generate this report, you must either manually install the `lxml`_
1124+
library or specify mypy installation with the setuptools extra
1125+
``mypy[reports]``.
1126+
1127+
.. option:: --linecount-report DIR
1128+
1129+
Causes mypy to generate a text file report documenting the functions
1130+
and lines that are typed and untyped within your codebase.
1131+
1132+
.. option:: --linecoverage-report DIR
1133+
1134+
Causes mypy to generate a JSON file that maps each source file's
1135+
absolute filename to a list of line numbers that belong to typed
1136+
functions in that file.
1137+
1138+
.. option:: --lineprecision-report DIR
1139+
1140+
Causes mypy to generate a flat text file report with per-module
1141+
statistics of how many lines are typechecked etc.
1142+
1143+
.. option:: --txt-report / --xslt-txt-report DIR
1144+
1145+
Causes mypy to generate a text file type checking coverage report.
1146+
1147+
To generate this report, you must either manually install the `lxml`_
1148+
library or specify mypy installation with the setuptools extra
1149+
``mypy[reports]``.
1150+
1151+
.. option:: --xml-report DIR
1152+
1153+
Causes mypy to generate an XML type checking coverage report.
1154+
1155+
To generate this report, you must either manually install the `lxml`_
1156+
library or specify mypy installation with the setuptools extra
1157+
``mypy[reports]``.
1158+
1159+
10991160
.. _enabling-incomplete-experimental-features:
11001161

11011162
Experimental features
@@ -1161,65 +1222,6 @@ Experimental features
11611222
This flag will make mypy print out all usages of a class member
11621223
based on static type information. This feature is experimental.
11631224

1164-
Report generation
1165-
*****************
1166-
1167-
If these flags are set, mypy will generate a report in the specified
1168-
format into the specified directory.
1169-
1170-
.. option:: --any-exprs-report DIR
1171-
1172-
Causes mypy to generate a text file report documenting how many
1173-
expressions of type ``Any`` are present within your codebase.
1174-
1175-
.. option:: --cobertura-xml-report DIR
1176-
1177-
Causes mypy to generate a Cobertura XML type checking coverage report.
1178-
1179-
To generate this report, you must either manually install the `lxml`_
1180-
library or specify mypy installation with the setuptools extra
1181-
``mypy[reports]``.
1182-
1183-
.. option:: --html-report / --xslt-html-report DIR
1184-
1185-
Causes mypy to generate an HTML type checking coverage report.
1186-
1187-
To generate this report, you must either manually install the `lxml`_
1188-
library or specify mypy installation with the setuptools extra
1189-
``mypy[reports]``.
1190-
1191-
.. option:: --linecount-report DIR
1192-
1193-
Causes mypy to generate a text file report documenting the functions
1194-
and lines that are typed and untyped within your codebase.
1195-
1196-
.. option:: --linecoverage-report DIR
1197-
1198-
Causes mypy to generate a JSON file that maps each source file's
1199-
absolute filename to a list of line numbers that belong to typed
1200-
functions in that file.
1201-
1202-
.. option:: --lineprecision-report DIR
1203-
1204-
Causes mypy to generate a flat text file report with per-module
1205-
statistics of how many lines are typechecked etc.
1206-
1207-
.. option:: --txt-report / --xslt-txt-report DIR
1208-
1209-
Causes mypy to generate a text file type checking coverage report.
1210-
1211-
To generate this report, you must either manually install the `lxml`_
1212-
library or specify mypy installation with the setuptools extra
1213-
``mypy[reports]``.
1214-
1215-
.. option:: --xml-report DIR
1216-
1217-
Causes mypy to generate an XML type checking coverage report.
1218-
1219-
To generate this report, you must either manually install the `lxml`_
1220-
library or specify mypy installation with the setuptools extra
1221-
``mypy[reports]``.
1222-
12231225

12241226
Miscellaneous
12251227
*************

0 commit comments

Comments
 (0)