From d549376a1b00d4a4c5927b8eb983bd281bbd1a40 Mon Sep 17 00:00:00 2001 From: Stephan Nordnes Eriksen Date: Wed, 14 Sep 2022 10:26:41 +0200 Subject: [PATCH] fix: improve --pyanalyse-report docs Currently the pyanalyze-report parameter is a bit poorly documented, and I believe that it is a very useful tool, so having a better explanation would be great. Here is a simple suggestion to make it easier to get going for the next person :) However, I'm not 100% sure the description is correct, so please make any adjustments as necessary. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38578fe..c26bc16 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ more transformations. The following are supported: - External integrations - `--pyanalyze-report`: takes types suggested by [pyanalyze](https://github.com/quora/pyanalyze)'s `suggested_parameter_type` - and `suggested_return_type` codes and applies them. + and `suggested_return_type` codes and applies them. Run pyanalyze with `python -m pyanalyze --json-output report.json *file or folder*`, then `--pyanalyze-report report.json`. - `--only-without-imports`: only apply pyanalyze suggestions that do not require new imports. This is useful because suggestions that require imports may need more manual work.