[Bug-Candidate]: filter paths documentation is incorrect

[engn33r]

Describe the issue:

The --filter-paths CLI argument and the "filter_paths" config file value serve the same purpose, which is to filter out specific files or directories from slither output. The way to provide multiple values to the CLI argument or the config file value is to separate the values with a | character. Multiple locations indicate a comment is the proper approach, which is incorrect. Using a comma will lead to filter the first value and ignoring all other values.

This documentation typo exists in at least two locations, there may be others:

1. The example config file in the wiki has a typo https://github.com/crytic/slither/wiki/Usage#configuration-file
2. The slither -h help message

   slither/slither/__main__.py

   Line 449 in 81daa56

   help="Comma-separated list of paths for which results will be excluded",

To separate multiple filter_paths values in the config file, the | character should be used, not a ,

#769 can be closed unless a comma separated list is preferred.

Code example to reproduce the issue:

Run slither twice, once using the config file example format and once using a | to separate multiple filter_path values. Do the same with the CLI "--filter-paths" argument. Using a comma causes all values after the first value to be ignored.

Version:

Slither 0.8.2

Relevant log output:

No response

[0xalpharush]

Thanks for bringing this to our attention. The filter-paths uses regex so separating filters with | is correct.

[engn33r]

Fixed by #1749