Skip to content

Commit 005fc1c

Browse files
pradyunsgpfmoore
andauthored
Rephrase note about the file format
Co-authored-by: Paul Moore <[email protected]>
1 parent 5f3a13d commit 005fc1c

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/html/reference/requirements-file-format.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ using {ref}`pip install`. Files that use this format are often called
66
these files are named (although, that is not a requirement).
77

88
```{note}
9-
This is NOT a format that other tools should try to consume.
10-
11-
It depends on various internal details of how pip works (eg: pip's CLI
12-
options) and is not designed for interoperability.
9+
The requirements file format is closely tied to a number of internal details of
10+
pip (e.g., pip's command line options). The basic format is relatively stable
11+
and portable but the full syntax, as described here, is only intended for
12+
consumption by pip, and other tools should take that into account before using
13+
it for their own purposes.
1314
```
1415

1516
## Structure

0 commit comments

Comments
 (0)