[FR] Offer an example usage command in the default header comment #2064
Labels
annotations
Related to packages annotations
enhancement
Improvements to functionality
writer
Related to results output writer component
What's the problem this feature will solve?
There's confusion as to how the output files are to be used and the header only shows how they were generated.
Describe the solution you'd like
I want the header to have an example on using the generated files as constraint. Specifically, suggesting to perform the installation via
PIP_CONSTRAINT=requirements.txt pip install -r requirements.in -c requirements.txt
. With the proper filenames, of course.Alternative Solutions
Letting the confusion live on..?
Additional context
This idea occurred to be having observed how different people have different expectations about using the pip-compile generated files in #2051.
The text was updated successfully, but these errors were encountered: