From 3725d1f9534d401ba76639834efd4179fb26f8eb Mon Sep 17 00:00:00 2001 From: Mike Salvatore Date: Thu, 28 Sep 2023 16:22:27 -0400 Subject: [PATCH] Whitelist path documentation (#328) * Add whitelist to configuration documentation It may be unclear to users that the whitelist is configurable by adding it to the `paths` variable in pyproject.toml (see https://github.com/jendrikseipp/vulture/issues/327). Adding it into the example configuration should make this more obvious. --------- Co-authored-by: Jendrik Seipp --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64ccf7b7..7d593526 100644 --- a/README.md +++ b/README.md @@ -179,7 +179,7 @@ ignore_decorators = ["@app.route", "@require_*"] ignore_names = ["visit_*", "do_*"] make_whitelist = true min_confidence = 80 -paths = ["myscript.py", "mydir"] +paths = ["myscript.py", "mydir", "whitelist.py"] sort_by_size = true verbose = true ```