diff options
| author | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-11-15 23:35:32 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-15 23:35:32 +0100 |
| commit | e3169329d3cd175d50a0eea2439dd4f7df4f46aa (patch) | |
| tree | 0ed54421db9a89a0486cb6304db9a4c4c28ea5bb /doc | |
| parent | 669b8e0c544b1ba0d4ea98cc766a33b92d4871a2 (diff) | |
| download | astroid-git-e3169329d3cd175d50a0eea2439dd4f7df4f46aa.tar.gz | |
Add boilerplate for documenting an upgrade guide (#1873)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/upgrade_guide.rst | 11 | ||||
| -rw-r--r-- | doc/whatsnew.rst | 1 |
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/upgrade_guide.rst b/doc/upgrade_guide.rst new file mode 100644 index 00000000..79c57496 --- /dev/null +++ b/doc/upgrade_guide.rst @@ -0,0 +1,11 @@ +=============== +Upgrade guide +=============== + +To ease the transition between major releases, the following page describes some of the breaking +changes between major release and what to change to safely upgrade. + +Upgrading from ``astroid`` ``2.x`` to ``3.0`` +--------------------------------------------- + +- Work in progress diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst index e26a3c7b..b30ebc4f 100644 --- a/doc/whatsnew.rst +++ b/doc/whatsnew.rst @@ -8,4 +8,5 @@ The "Changelog" contains *all* nontrivial changes to astroid for the current ver .. toctree:: :maxdepth: 2 + upgrade_guide changelog |