From b6fae7161611e0b820231d1e80432ee746adee50 Mon Sep 17 00:00:00 2001 From: Jendrik Seipp Date: Mon, 13 Nov 2023 19:06:51 +0100 Subject: [PATCH] Clarify that --ignore-decorators only ignores method names. --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7d593526..99b2ec81 100644 --- a/README.md +++ b/README.md @@ -107,10 +107,11 @@ make it harder to read. You can use `--ignore-names foo*,ba[rz]` to let Vulture ignore all names starting with `foo` and the names `bar` and `baz`. Additionally, the -`--ignore-decorators` option can be used to ignore functions decorated -with the given decorator. This is helpful for example in Flask projects, -where you can use `--ignore-decorators "@app.route"` to ignore all -functions with the `@app.route` decorator. Note that Vulture simplifies +`--ignore-decorators` option can be used to ignore the names of functions +decorated with the given decorator (but not their arguments or function body). +This is helpful for example in Flask +projects, where you can use `--ignore-decorators "@app.route"` to ignore all +function names with the `@app.route` decorator. Note that Vulture simplifies decorators it cannot parse: `@foo.bar(x, y)` becomes "@foo.bar" and `@foo.bar(x, y).baz` becomes "@" internally.