Skip to content

Conversation

wyattscarpenter
Copy link
Contributor

@wyattscarpenter wyattscarpenter commented Sep 17, 2025

When I started using the reports functionality, I found its --help documentation a bit confusing at first. This elaborates it a little bit to make it clear that the "DIR" is an output dir (and not, say, a source dir).

I manually tested this to make sure the new help text was right. It does the obvious thing, indeed. Here is a diff:

255c255
<   Generate a report in the specified format.
---
>   Generate a report in the specified format in the specified directory.
257,266c257,266
<   --any-exprs-report DIR
<   --cobertura-xml-report DIR
<   --html-report DIR
<   --linecount-report DIR
<   --linecoverage-report DIR
<   --lineprecision-report DIR
<   --txt-report DIR
<   --xml-report DIR
<   --xslt-html-report DIR
<   --xslt-txt-report DIR
---
>   --any-exprs-report OUTPUT_DIR
>   --cobertura-xml-report OUTPUT_DIR
>   --html-report OUTPUT_DIR
>   --linecount-report OUTPUT_DIR
>   --linecoverage-report OUTPUT_DIR
>   --lineprecision-report OUTPUT_DIR
>   --txt-report OUTPUT_DIR
>   --xml-report OUTPUT_DIR
>   --xslt-html-report OUTPUT_DIR
>   --xslt-txt-report OUTPUT_DIR

Out of curiosity, I also manually tested what happens if you remove the metavar here. It displays long default metavars like SPECIAL-OPTS:HTML_REPORT, which is not helpful — so I didn't do that.

This comment has been minimized.

@wyattscarpenter wyattscarpenter changed the title [docs] Small improvement to report --help documentation [docs] Small improvement to report --help documentation Sep 17, 2025
Copy link
Contributor

Diff from mypy_primer, showing the effect of this PR on open source code:

AutoSplit (https://github.com/Toufool/AutoSplit)
-   File "/tmp/mypy_primer/mypy_old/venv/bin/mypy", line 7, in <module>
+   File "/tmp/mypy_primer/mypy_new/venv/bin/mypy", line 7, in <module>
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/__main__.py", line 15, in console_entry
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 127, in main
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/main.py", line 211, in run_build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 196, in build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 272, in _build
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2946, in dispatch
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3346, in process_graph
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 3475, in process_stale_scc
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/build.py", line 2493, in write_cache
-   File "/tmp/mypy_primer/mypy_old/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__
+   File "/tmp/mypy_primer/mypy_new/venv/lib/python3.13/site-packages/mypy/cache.py", line 28, in __init__

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant