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

Documentation for Path objects is misleading

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: P3: Somewhat important P3: Somewhat important
    • None
    • 5.10
    • Documentation
    • None

      doc.qt.io/qt-5/qml-qtquick-pathcubic.html, http://doc.qt.io/qt-5/qml-qtquick-patharc.html, etc. all have documentation that says:

      The following QML produces the path shown below:

      and then has a picture of the resulting shape, which is misleading without extra context, as it only produces that shape within the context of PathView. Users reading the documentation don't make that connection, so they assume that these types can render shapes on their own.

      I pushed one patch for Path, but there it was just a note:

      https://codereview.qt-project.org/#/c/203504/

      Perhaps we could do something similar for the types whose documentation has images, so that users aren't confused. A note at the bottom might not be enough though; we might have to reword the existing docs.

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

            docteam Qt Documentation Team
            mitch_curtis Mitch Curtis
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:

                There are no open Gerrit changes