Skip to content

Commit 3b52621

Browse files
committed
Document purpose of the upstream requirements
These were already documented through commits and code. It adds a few sentences of explanation for why the upstream requirements exists to the README, so that people know what they are updating.
1 parent 56e17b1 commit 3b52621

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

test/README.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,11 @@ In order to run these integration tests successfully, these things which must be
1818
Updating Upstream Requirements
1919
==============================
2020

21-
In order to update the upstream requirements in `upstream-requirements-py37.txt` and
21+
The purpose of the upstream requirements files is to provide a stable list of
22+
packages for pyca/cryptography's downstream test of the DynamoDB Encryption
23+
Client. They are frozen so that dependencies unrelated to pyca/cryptography
24+
don't break the pyca/cryptography CI. In order to update the upstream
25+
requirements in `upstream-requirements-py37.txt` and
2226
`upstream-requirements-py27.txt`, run these commands:
2327

2428
.. code::
@@ -27,6 +31,7 @@ In order to update the upstream requirements in `upstream-requirements-py37.txt`
2731
$ tox -e freeze-upstream-requirements-py37
2832
2933
Test them using:
34+
3035
.. code::
3136
$ tox -e test-upstream-requirements-py27
3237
$ tox -e test-upstream-requirements-py37

0 commit comments

Comments
 (0)