Update pyanalyse-report documentation

JelleZijlstra / autotyping

Automatically add simple type annotations to your code

240 stars 20 forks source link

Update pyanalyse-report documentation #41

Open stephan-nordnes-eriksen opened 2 years ago

stephan-nordnes-eriksen commented 2 years ago

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.

I'm not really able to get pyanalyze-report to do anything on my machine, but perhaps pyanalyze didn't find any appropriate suggestions.

JelleZijlstra commented 2 years ago

You need to add -e suggested_parameter_type and/or -e suggested_return_type I believe so that it emits the right diagnostics in the report.