Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pyanalyse-report documentation #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

stephan-nordnes-eriksen

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.

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.
@JelleZijlstra
Copy link
Owner

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.

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.

2 participants