aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc
diff options
context:
space:
mode:
authorCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2020-03-29 20:27:25 +0200
committerCristian Maureira-Fredes <cristian.maureira-fredes@qt.io>2020-03-30 08:43:51 +0200
commit47217affdb35850d2b8ca67b3f0a9b04fbd02fc7 (patch)
tree285ee339ba000e3cc83b761fd0af116de49656a6 /sources/pyside2/doc
parentd47fb98e443e3ac5cb18850b2551143c713917f0 (diff)
doc: add clarification to examples page
New users are getting confused by the phrasing of the page, and believe we only have two examples in our codebase. Adding a paragraph to clarify this situation will solve the misconception. Change-Id: I2a18d99771eee82af3181a997c137109840edbec Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc')
-rw-r--r--sources/pyside2/doc/pyside-examples/examples.qdoc7
1 files changed, 6 insertions, 1 deletions
diff --git a/sources/pyside2/doc/pyside-examples/examples.qdoc b/sources/pyside2/doc/pyside-examples/examples.qdoc
index d82b33cf7..748c4f8fd 100644
--- a/sources/pyside2/doc/pyside-examples/examples.qdoc
+++ b/sources/pyside2/doc/pyside-examples/examples.qdoc
@@ -28,5 +28,10 @@
/*!
\group all-pyside-examples
\title All Qt for Python Examples
- \brief A list of all the examples that are available with the Qt for Python package.
+ \brief A varied selection of examples can be found in the 'examples' directory of the
+ pyside-setup repository. This can be accessed after installing
+ PySide2 via pip, checking the 'site-packages/PySide2/examples' directory.
+
+ This page aims to document the most important use cases of the module
+ and it will be extended with each release.
*/