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

Doc: Update documentation and snippets

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Open
    • Priority: P2: Important
    • Resolution: Unresolved
    • Affects Version/s: 5.9, 5.11.0, dev
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      The generated documentation include code from Qt.
      Some of this code has been translated to Python, and it is currently placed in:

      sources/pyside2/doc/codesnippets/doc/src/snippets/
      

      Still, there are a few things to be addressed:

      • Verify if all the Python code portions works
      • Translate all the C++ references to Python
      • Exclude the elements that we are not using, e.g.: QList<String> exists only as a Python string list, but we currently have documentation about it.

      Additionally, some functions needs extra explanation, like QObject.findChild/find.Children and return types that are described as a python type that is not clear, e.g.: PyTuple.

        Attachments

          Issue Links

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

            Activity

              People

              • Assignee:
                crmaurei Cristian Maureira-Fredes
                Reporter:
                crmaurei Cristian Maureira-Fredes
                RnD Owner:
                Alex Blasche
              • Votes:
                2 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated: