Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
avi-jois committed Apr 6, 2023
1 parent bdfca5b commit 9583307
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -532,11 +532,11 @@ dependencies, making any newly generated ``requirements.txt`` environment-depend
As a general rule, it's advised that users should still always execute ``pip-compile``
on each targeted Python environment to avoid issues.

There is a feature (`--override-environment`) that can be used to
There is a feature (``--override-environment``) that can be used to
specify the environment when gathering dependencies, allowing for cross-environment
fetching. However, a different ``requirements.txt`` must still be generated per
environment. It is recommended to override all keys in `PEP 508` when targetting a
different environment so the environment is fully defined.
environment. It is recommended to override all keys in `PEP 508 environment markers`_
when targetting a different environment so the environment is fully defined.

.. _PEP 508 environment markers: https://www.python.org/dev/peps/pep-0508/#environment-markers

Expand Down

0 comments on commit 9583307

Please sign in to comment.