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

Doc fix: Use hyphen to install prospector with mypy and bandit in pre-commit #634

Merged

Conversation

jdechicchis
Copy link
Contributor

Doc fix to use - instead of _ to install mypy/bandit with prospector in pre-commit.

Description

See #633. From this discussion seems to be related to how poetry resolves optional dependencies

Related Issue

#633

Motivation and Context

Makes docs clearer.

How Has This Been Tested?

Used this updated pre-commit config in my own project, which was previously experiencing dependency install issues.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • My change requires a change to the dependencies
  • I have updated the dependencies accordingly
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@jdechicchis jdechicchis changed the title Doc fix: Use hyphen to install prospector with mypy and bandit Doc fix: Use hyphen to install prospector with mypy and bandit in pre-commit Sep 12, 2023
Copy link
Collaborator

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you !

@Pierre-Sassoulas Pierre-Sassoulas merged commit 34a3eba into prospector-dev:master Sep 12, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants