You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I constantly forget which parameters to use when compiling the requirements. My most common use cases:
Upgrade packages
Compile requirements in requirements folder
Dry run
Describe the solution you'd like
Add examples of the most common use cases of pip-compile for --help comand. For example, dramatiq has few examples of usage under a list of parameters:
...
--version show program's version number and exit
--verbose, -v turn on verbose log output
examples:
# Run dramatiq workers with actors defined in `./some_module.py`.
$ dramatiq some_module
# Run with a broker named "redis_broker" defined in "some_module".
$ dramatiq some_module:redis_broker
....
Alternative Solutions
Read documentation, review all flags every time, learn all parameters
Thanks for bringing this up! Yes, we need proper documentation. Unfortunately, --help becomes a mess and still growing. Any help is highly welcomed and encouraged.
Activity
atugushev commentedon May 11, 2020
Hello @hyzyla,
Thanks for bringing this up! Yes, we need proper documentation. Unfortunately,
--helpbecomes a mess and still growing. Any help is highly welcomed and encouraged.webknjaz commentedon Jul 8, 2023
FWIW, cURL has a categorized help like
curl --help allwithcurl --helpbeing short.https://clig.dev/#help documents the complex help sections very well, offering good advice. We should follow it whenever possible.