diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-04-25 11:42:28 +0200 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2018-04-30 09:07:48 +0000 |
| commit | 1d6bad63bcb6720078de1e78c1b495bf08d1c65b (patch) | |
| tree | adeb4135abb17af9d5cd88e1081d7ef365b3c89d /sources/pyside2/doc/pysideapi2.rst | |
| parent | 8f7d78ce992943f4bac0c70ace96a52a8dd72ecf (diff) | |
Doc: Use product name and python module names appropriately
Configured replaceable text entities so that updating instances
of product and module names in the doc is less cumbersome.
Change-Id: I6ef8adcc4324775eeb8a48bf81294effb0ea12d5
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/pysideapi2.rst')
| -rw-r--r-- | sources/pyside2/doc/pysideapi2.rst | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/sources/pyside2/doc/pysideapi2.rst b/sources/pyside2/doc/pysideapi2.rst index 5769ca83b..f1cc13391 100644 --- a/sources/pyside2/doc/pysideapi2.rst +++ b/sources/pyside2/doc/pysideapi2.rst @@ -1,20 +1,11 @@ .. _pysideapi2: -|project| API +|pymodname| API *************** -Since the beginning one of the PySide goals was to be API compatible with PyQt4, -but with some (documented) exceptions. For example, PySide will not export to -Python components marked as deprecated on C++ Qt. All the modifications follow -the `PSEP101 <http://www.pyside.org/docs/pseps/psep-0101.html>`_ as its guideline. - -The release 4.7 of PyQt4 came with improvements on the pythonic front, being -the extinction of QString a good example. PySide followed this change, except in -one point: while PyQt4 has conserved the old behavior as optional, PySide -bindings fully adopted the new API - completely removing QString. No turning -back. Thus remember to update your source code to the new API, this will ensure -your code will run on both bindings. - +One of the goals of |pymodname| is to be API compatible with PyQt5, +with certain exceptions. For example, |pymodname| will not export C++ components +that are marked as deprecated by Qt. __hash__() function return value ================================ |