Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-78266

DelegateChooser and DelegateChoice documentation errors

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Fixed
    • Affects Version/s: 5.13
    • Fix Version/s: 5.14.0
    • Component/s: Documentation
    • Labels:
    • Platform/s:
      All
    • Sprint:
      DaVinci X-mas sprint

      Description

      The documentation for the QML types DelegateChooser and DelegateChoice has a few errors:

      1. Both types show incorrect import statements on their documentation pages: 
        1. https://doc.qt.io/qt-5.13/qml-delegatechooser.html
        2. https://doc.qt.io/qt-5.13/qml-delegatechoice.html
      2. The Qt Labs Platform module documentation does not reference these types: https://doc.qt.io/qt-5.13/qtlabsplatform-index.html#
      3. Both DelegateChooser and DelegateChoice are shown on the "All QML Types" page despite being in Qt Labs: https://doc.qt.io/qt-5.13/qmltypes.html. It's not clear to me if this is intentional or not but it seems to be inconsistent with the other Qt Labs types because they are not shown on this page.
      4. Not entirely an issue, but something to note- The previous 5.12 links to these types are no longer valid in the 5.13 documentation:
        1. https://doc.qt.io/qt-5.12/qml-qt-labs-qmlmodels-delegatechoice.html vs https://doc.qt.io/qt-5.13/qml-qt-labs-qmlmodels-delegatechoice.html
        2. https://doc.qt.io/qt-5.12/qml-qt-labs-qmlmodels-delegatechooser.html vs https://doc.qt.io/qt-5.13/qml-qt-labs-qmlmodels-delegatechooser.html

      (1) is a regression from 5.12 because the import statement of both types was previously documented correctly: https://doc.qt.io/qt-5.12/qml-qt-labs-qmlmodels-delegatechoice.html

      (2) is not a regression because these types were not listed on the 5.12 Qt Labs Platform module documentation either. https://doc.qt.io/qt-5.12/qtlabsplatform-index.html#

      (3) is not a regression because both types were shown on the "All QML Types" page in the 5.12 documentation. https://doc.qt.io/qt-5.12/qmltypes.html

      In the 5.13 documentation it is unclear what the proper import statement to use these types is. Based on the 5.13 source code, it appears that the import statement should be the same as it was before (based on ./Src/qtdeclarative/src/imports/labsmodels/plugins.qmltypes):

      import Qt.labs.qmlmodels 1.0

      This might be a reoccurring issue because it looks like there was an issue with the documentation of these types initially in 5.12 too: QTBUG-71316

       

        Attachments

          Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            Activity

              People

              • Assignee:
                leenam Leena Miettinen
                Reporter:
                tomhrabchak Tom Hrabchak
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes