Improve report --help documentation

wyattscarpenter · wyattscarpenter · commit a8ea37a8dd11 · 2025-09-17T14:22:54.000+07:00
diff --git a/mypy/main.py b/mypy/main.py
@@ -1127,13 +1127,13 @@ def add_invertible_flag(
     internals_group.add_argument("--export-ref-info", action="store_true", help=argparse.SUPPRESS)
 
     report_group = parser.add_argument_group(
-        title="Report generation", description="Generate a report in the specified format."
+        title="Report generation", description="Generate a report in the specified format in the specified directory."
     )
     for report_type in sorted(defaults.REPORTER_NAMES):
         if report_type not in {"memory-xml"}:
             report_group.add_argument(
                 f"--{report_type.replace('_', '-')}-report",
-                metavar="DIR",
+                metavar="OUTPUT_DIR",
                 dest=f"special-opts:{report_type}_report",
             )
 

Original file line number	Diff line number	Diff line change
`@@ -1127,13 +1127,13 @@ def add_invertible_flag(`
`1127`	`1127`	`internals_group.add_argument("--export-ref-info", action="store_true", help=argparse.SUPPRESS)`
`1128`	`1128`
`1129`	`1129`	`report_group = parser.add_argument_group(`
`1130`		`- title="Report generation", description="Generate a report in the specified format."`
	`1130`	`+ title="Report generation", description="Generate a report in the specified format in the specified directory."`
`1131`	`1131`	`)`
`1132`	`1132`	`for report_type in sorted(defaults.REPORTER_NAMES):`
`1133`	`1133`	`if report_type not in {"memory-xml"}:`
`1134`	`1134`	`report_group.add_argument(`
`1135`	`1135`	`f"--{report_type.replace('_', '-')}-report",`
`1136`		`- metavar="DIR",`
	`1136`	`+ metavar="OUTPUT_DIR",`
`1137`	`1137`	`dest=f"special-opts:{report_type}_report",`
`1138`	`1138`	`)`
`1139`	`1139`