Skip to content

Commit 1014300

Browse files
committed
Add basic doc on making dep changes based on previously written one
1 parent f3e8be9 commit 1014300

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

source/dependency-changes.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Making dependency changes
2+
=========================
3+
4+
Updating Python package dependencies
5+
------------------------------------
6+
7+
To update all dependencies, script for bumping deps (``tools/bumpdeps.py``) should be used.
8+
9+
When updating dependencies:
10+
11+
- Verify that all code commented with ``DEP-WARN`` is not affected by the new dependency versions
12+
- Read the changelogs for dependencies to make sure there are no (breaking) changes
13+
that may affect our code

source/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,5 @@ Full Table of Contents
99

1010
.. toctree::
1111
:maxdepth: 2
12+
13+
dependency-changes

0 commit comments

Comments
 (0)