Skip to content

Commit e316932

Browse files
authored
Add boilerplate for documenting an upgrade guide (#1873)
1 parent 669b8e0 commit e316932

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

doc/upgrade_guide.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
===============
2+
Upgrade guide
3+
===============
4+
5+
To ease the transition between major releases, the following page describes some of the breaking
6+
changes between major release and what to change to safely upgrade.
7+
8+
Upgrading from ``astroid`` ``2.x`` to ``3.0``
9+
---------------------------------------------
10+
11+
- Work in progress

doc/whatsnew.rst

+1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ The "Changelog" contains *all* nontrivial changes to astroid for the current ver
88
.. toctree::
99
:maxdepth: 2
1010

11+
upgrade_guide
1112
changelog

0 commit comments

Comments
 (0)