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

Update our published QML code to reflect current best practices

XMLWordPrintable

    • Showcasing QML best practices

      Background
      QML is a relatively young language. The language itself and the tools around it are both evolving quite rapidly. For example,

       

      However, a substantial amount of our examples, documentation, and code were written before these features became available. Consequently, they showcase old techniques (some which are now discouraged) and/or they light up with warnings when the user loads them:

       

      Task

      We must update them to use current best practices, so that:

      • We take the lead in teaching best practices; we don't contribute to the inertial entrenchment of now-discouraged practices
      • Our official examples look professional and trustworthy, free of warnings (QTBUG-110934)

       

      Target Audience

      The tasks under this Epic are for the benefit of two broad groups:

      • Qt users (the primary target audience of our documentation and examples):
        • They rely on our examples and documentation to learn how to use Qt. If they see discouraged practices, then they will learn discouraged practices.
        • Examples/documentation that produce warnings causes user frustration and raises questions about the quality of our software.
      • Those of us who design API for Qt users; those of us who review code/API/examples/documentation
        • Many people who write QML code are not experts in the cutting-edge developments of QML.
        • They might rely on internal, non-user-facing code as a template/reference for their work. Thus, such existing code can influence the design of new APIs/examples, and the outcomes of code reviews.

       

      Thus, the tasks under this Epic cover examples, documentation, AND internal source code.

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

            docteam Qt Documentation Team
            skoh-qt Sze Howe Koh
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:

                There are no open Gerrit changes