Skip to content

Commit

Permalink
updated docs for poetry-export hook to match new default
Browse files Browse the repository at this point in the history
  • Loading branch information
Cielquan committed Jun 7, 2020
1 parent d23f761 commit 4c3338d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/docs/pre-commit-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,16 @@ to sync your `requirements.txt` file with your current dependencies.
The hook takes the same arguments as the poetry command.
For more information see the [export command](/docs/cli#export).

If no arguments are given the hook falls back to `args: ["-f", "requirements.txt"]`.
If you want to see the output on the commandline add `verbose: true` to `poetry-export`
`args: ["-f", "requirements.txt", "-o", "requirements.txt"]` are the default arguments
which will create/update the requirements.txt file in the current working directory.

For output to the console change the arguments and add `verbose: true` to `poetry-export`
in your `.pre-commit-config.yaml` file like so:

```yaml
hooks:
- id: poetry-export
args: ["-f", "requirements.txt"]
verbose: true
```

Expand Down

0 comments on commit 4c3338d

Please sign in to comment.