search

bndr / pipreqs

pipreqs - Generate pip requirements.txt file based on imports of any project. Looking for maintainers to move this project forward.
Apache License 2.0
6.38k stars 388 forks source link

Doc should inform user that the `--ignore` option takes a list of comma-separated directories as input #213

Closed MapleCCC closed 3 years ago

MapleCCC commented 4 years ago

It's not shown in the doc that the --ignore option takes a list of comma-separted directories as input. After failing with space-separated directoreis, I need to dwell into the source code to figure this out. It would be better if the doc could inform user about this behaviour. We don't want to make user surprised.

kumiDa commented 3 years ago

When invoking the help for pipreqs through the following command

$pipreqs --help

We can notice the following statement that clearly states that the directories passed to the --ignore option are to be separated by commas.

--ignore <dirs>...    Ignore extra directories, each separated by a comma.

This is not clarified in README.rst.

MapleCCC commented 3 years ago

@rahul-kumi Thank you for the information. This discrepancy between README CLI doc and actual CLI doc is quite annoying, and requires additional care from developer to maintain consistency. Would be good if anyone could make a GitHub bot that automatically warns developer about this specific kind of problem.

kumiDa commented 3 years ago

@alan-barzilay, this is something that needs to be taken care when the next release is made.

alan-barzilay commented 3 years ago

closed by #254