Skip to content

Add boilerplate for documenting an upgrade guide #1873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 15, 2022
Merged

Add boilerplate for documenting an upgrade guide #1873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e84b54e
Add boilerplate for documenting an upgrade guide
DanielNoord Nov 15, 2022
3dc6e27
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/upgrade_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions doc/whatsnew.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ The "Changelog" contains *all* nontrivial changes to astroid for the current ver
.. toctree::
:maxdepth: 2

upgrade_guide
changelog