Skip to content

Commit 70d7ce1

Browse files
committed
Describe some dependancy changes in API break docs
1 parent 08218de commit 70d7ce1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

doc/api_break.dox

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,31 @@ This page tries to maintain a list with incompatible changes that happened in pr
2121
QGIS 3.0 {#qgis_api_break_3_0}
2222
========
2323

24+
Version 3.0 brings changes to many underlying dependancies which QGIS is built upon. Any existing PyQGIS code will
25+
need to be updated to address the changes made within these libraries.
26+
27+
Python 3.0
28+
----------
29+
30+
QGIS 3.0 introduces a move to Python 3. This version brings many changes to both the Python language and individual Python
31+
libraries. A good place to start learning about the changes involved, and how to port your code to Python 3, is available
32+
in the official Python documentation: [Porting Python 2 Code to Python 3](https://docs.python.org/3/howto/pyporting.html).
33+
34+
Qt 5
35+
----
36+
37+
QGIS 3.0 is based off version 5 of the underlying Qt libraries. Many changes and API breaks were introduced in Qt5. While
38+
it is c++ specific, a good place to read about the major changes introduced in Qt5 is at the Qt docs:
39+
[C++ API changes](http://doc.qt.io/qt-5/sourcebreaks.html)
40+
41+
42+
PyQt 5
43+
------
44+
45+
Together with the Python and Qt version changes, the PyQt libraries which expose Qt classes to Python have also had their
46+
version bumped to PyQt 5. The changes introduced in PyQt 5 and the steps required to upgrade existing code are summarised at:
47+
[Differences Between PyQt4 and PyQt5](http://pyqt.sourceforge.net/Docs/PyQt5/pyqt4_differences.html)
48+
2449
Moved Classes {#qgis_api_break_3_0_moved_classes}
2550
-------------
2651

0 commit comments

Comments
 (0)