Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-1863

Documention for Slot is inadequate and assumes PyQt6 knowledge

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Done
    • Not Evaluated
    • None
    • 6.2.2
    • PySide
    • None
    • All
    • 6688ec92f4 (pyside/pyside-setup/dev) aaf5cfcef3 (pyside/pyside-setup/6.2) aaf5cfcef3 (pyside/tqtc-pyside-setup/6.2)

    Description

      The PySide documentation for Slot assumes the reader is intimately aware of PyQt6 and how its Slot syntax work.  But if the reader is simply new to Qt6 and PySide6, that isn't helpful at all to them.

       

      https://doc.qt.io/qtforpython/PySide6/QtCore/Slot.html

      "**PySide6 adopt PyQt’s new signal and slot syntax as-is" is about the entirety of the page.

      Further, the docs for Property imply that one should use the _doc_ attribute to learn all about the supported attributes.  But that doesn't work for Property or Slot.

      Python 3.8.10 (default, Nov 26 2021, 20:14:08)
      [GCC 9.3.0] on linux
      Type "help", "copyright", "credits" or "license" for more information.
      >>> import PySide6.QtCore
      >>> print(PySide6.QtCore.Property._doc_)
      <attribute '_doc_' of 'PySide6.QtCore.Property' objects>
      >>> print(PySide6.QtCore.Slot._doc_)
      None
      >>>

      Attachments

        For Gerrit Dashboard: PYSIDE-1863
        # Subject Branch Project Status CR V

        Activity

          People

            crmaurei Cristian Maureira-Fredes
            johnf John Freeborg
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes