We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug
The documentation for additional_dependencies to run prospector as a pre-commit hook with mypy support appears incorrect.
additional_dependencies
To Reproduce
Follow the instructions at https://github.com/landscapeio/prospector/blob/master/docs/pre-commit.rst with pre-commit config:
- repo: https://github.com/PyCQA/prospector rev: 1.10.0 hooks: - id: prospector additional_dependencies: - .[with_mypy] args: [--with-tool=mypy]
Run pre-commit and get error:
cannot run tool mypy as support was not installed. Please install by running 'pip install prospector[with_mypy]'
Now change pre-commit config to (note the change in underscore with_mypy to hyphen with-mypy):
with_mypy
with-mypy
- repo: https://github.com/PyCQA/prospector rev: 1.10.0 hooks: - id: prospector additional_dependencies: - .[with-mypy] args: [--with-tool=mypy]
pre-commit runs as expected
Expected behavior
Following the docs should lead to running prospector with mypy support in pre-commit without error.
Environment (please complete the following information):
1.10.2
3.11.5
3.4.0
Additional context
Happy to make a PR to update the docs!
The text was updated successfully, but these errors were encountered:
Thanks for opening the issue ! (you probably could have made the PR directly ;))
Sorry, something went wrong.
Done! Will do next time 😄
No branches or pull requests
Describe the bug
The documentation for
additional_dependencies
to run prospector as a pre-commit hook with mypy support appears incorrect.To Reproduce
Follow the instructions at https://github.com/landscapeio/prospector/blob/master/docs/pre-commit.rst with pre-commit config:
Run pre-commit and get error:
Now change pre-commit config to (note the change in underscore
with_mypy
to hyphenwith-mypy
):pre-commit runs as expected
Expected behavior
Following the docs should lead to running prospector with mypy support in pre-commit without error.
Environment (please complete the following information):
1.10.2
3.11.5
3.4.0
Additional context
Happy to make a PR to update the docs!
The text was updated successfully, but these errors were encountered: