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

pre-commit hook usage is wrong in documentation #281

Open
leoyala opened this issue May 24, 2024 · 0 comments
Open

pre-commit hook usage is wrong in documentation #281

leoyala opened this issue May 24, 2024 · 0 comments
Labels
fresh This is a new issue

Comments

@leoyala
Copy link

leoyala commented May 24, 2024

Hello,

I started using docformatter as a pre-commit hook, and noticed that the description on how to use it is wrong in the documentation. In the webpage, it is indicated that the usage is:

- repo: https://github.com/PyCQA/docformatter
  rev: v1.7.5
  hooks:
    - id: docformatter
      additional_dependencies: [tomli]
      args: [--in-place --config ./pyproject.toml]

However, using it like this leads to pre-commit ignoring the arguments. To fix this, I had to separate each argument in the list and surround it with quotes, like this:

- repo: https://github.com/PyCQA/docformatter
  rev: v1.7.5
  hooks:
    - id: docformatter
      additional_dependencies: [tomli]
      args: ["--in-place", "--config=./pyproject.toml"]

It would be good to update the documentation.

P.S.: I am using WSL with Ubuntu 22.04 and version v.7.5 of docformatter.

@github-actions github-actions bot added the fresh This is a new issue label May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fresh This is a new issue
Projects
None yet
Development

No branches or pull requests

1 participant