aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/pysideapi2.rst
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-10-19 10:28:39 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2018-10-19 08:48:36 +0000
commit6f2f10e84a030bd46f336b00a0618e7ed2a87d12 (patch)
treed20fab12301bb8c8817682387d5056d895739802 /sources/pyside2/doc/pysideapi2.rst
parente10339acbdaaf640384c2eae3e7ce5c792605cfb (diff)
Update documentation
A couple of comments were outdated, and there was mixed information related to PySide, PySide2 and Qt for Python. Task-number: PYSIDE-691 Change-Id: I34c17822fc09e9027ee1c0a082ed9a27a5154996 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/pysideapi2.rst')
-rw-r--r--sources/pyside2/doc/pysideapi2.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/sources/pyside2/doc/pysideapi2.rst b/sources/pyside2/doc/pysideapi2.rst
index f1cc13391..e552bf21d 100644
--- a/sources/pyside2/doc/pysideapi2.rst
+++ b/sources/pyside2/doc/pysideapi2.rst
@@ -1,12 +1,15 @@
.. _pysideapi2:
-|pymodname| API
-***************
+Qt for Python API
+*******************
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.
+The latest considerations and known issues will be also reported
+in the `wiki <https://wiki.qt.io/Qt_for_Python/Considerations>`_.
+
__hash__() function return value
================================